From ceab4108497b6fd1d44058de14ae97fe6abeda75 Mon Sep 17 00:00:00 2001 From: Charles Treatman Date: Thu, 11 Dec 2025 13:29:17 -0600 Subject: [PATCH 1/5] fix whitespace in template to avoid creating lint issues --- templates/cmd/service.go.tmpl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/templates/cmd/service.go.tmpl b/templates/cmd/service.go.tmpl index b62f806..98a93cf 100644 --- a/templates/cmd/service.go.tmpl +++ b/templates/cmd/service.go.tmpl @@ -29,7 +29,7 @@ providing access to all available API services.`, // Inject the client factory into the command context so that // it can be retrieved at execution time executionClientFactory := func() (register.APIClientInterface, error) { - {{SERVICE}}.SetDebug({{SERVICE}}Debug) + {{SERVICE}}.SetDebug({{SERVICE}}Debug) return {{SERVICE}}.NewClient() } cmd.SetContext(register.ContextWithClientFactory(cmd.Context(), executionClientFactory)) @@ -70,7 +70,7 @@ func init() { // Uncomment and customize aliases as needed for convenience // Example: Add shorter aliases for commonly used commands // {{SERVICE}}Cmd.Aliases = []string{"{{SERVICE_ALIAS}}"} - // + // // Or add aliases to specific subcommands after registration: // if connectionsCmd, _, err := {{SERVICE}}Cmd.Find([]string{"connections"}); err == nil { // if createCmd, _, err := connectionsCmd.Find([]string{"create-connection"}); err == nil { From af80ccea643f525dbe257fd63be05e3a74fc1411 Mon Sep 17 00:00:00 2001 From: Charles Treatman Date: Thu, 11 Dec 2025 13:38:18 -0600 Subject: [PATCH 2/5] skip linter error due to metalv1 API client selection logic --- .golangci.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.golangci.yaml b/.golangci.yaml index 5b398f3..716ed84 100644 --- a/.golangci.yaml +++ b/.golangci.yaml @@ -15,6 +15,10 @@ linters: - linters: - revive text: "^package-comments" + # TODO: remove this exclusion when metalv1 is + # removed from the SDK & CLI + - path: internal/metalv1/metalv1.go + text: "SA4000:" formatters: enable: - goimports From a0906ebd525db1ff7bed8935377fdf155e420e96 Mon Sep 17 00:00:00 2001 From: Charles Treatman Date: Wed, 17 Dec 2025 11:15:27 -0600 Subject: [PATCH 3/5] run make generate-all --- cmd/accesstokenv1.go | 80 + cmd/descriptions/accesstokenv1.json | 608 + cmd/descriptions/eiav2.json | 3741 ++ cmd/descriptions/fabricv4.json | 33082 ++++++++++++++++++ cmd/descriptions/lookupv2.json | 1351 + cmd/descriptions/metalv1.json | 29092 +++++++++++++++ cmd/descriptions/orderhistoryv1.json | 1120 + cmd/descriptions/ordersv2.json | 1697 + cmd/descriptions/securecabinetv1.json | 1104 + cmd/descriptions/smarthandsv1.json | 3232 ++ cmd/descriptions/stsv1alpha.json | 520 + cmd/eiav2.go | 80 + cmd/fabricv4.go | 80 + cmd/lookupv2.go | 80 + cmd/metalv1.go | 80 + cmd/orderhistoryv1.go | 80 + cmd/ordersv2.go | 80 + cmd/securecabinetv1.go | 80 + cmd/smarthandsv1.go | 80 + cmd/stsv1alpha.go | 80 + go.mod | 2 +- go.sum | 5 +- internal/accesstokenv1/accesstokenv1.go | 53 + internal/eiav2/eiav2.go | 53 + internal/fabricv4/fabricv4.go | 53 + internal/lookupv2/lookupv2.go | 53 + internal/metalv1/metalv1.go | 53 + internal/orderhistoryv1/orderhistoryv1.go | 53 + internal/ordersv2/ordersv2.go | 53 + internal/securecabinetv1/securecabinetv1.go | 53 + internal/smarthandsv1/smarthandsv1.go | 53 + internal/stsv1alpha/stsv1alpha.go | 53 + 32 files changed, 76880 insertions(+), 4 deletions(-) create mode 100644 cmd/accesstokenv1.go create mode 100644 cmd/descriptions/accesstokenv1.json create mode 100644 cmd/descriptions/eiav2.json create mode 100644 cmd/descriptions/fabricv4.json create mode 100644 cmd/descriptions/lookupv2.json create mode 100644 cmd/descriptions/metalv1.json create mode 100644 cmd/descriptions/orderhistoryv1.json create mode 100644 cmd/descriptions/ordersv2.json create mode 100644 cmd/descriptions/securecabinetv1.json create mode 100644 cmd/descriptions/smarthandsv1.json create mode 100644 cmd/descriptions/stsv1alpha.json create mode 100644 cmd/eiav2.go create mode 100644 cmd/fabricv4.go create mode 100644 cmd/lookupv2.go create mode 100644 cmd/metalv1.go create mode 100644 cmd/orderhistoryv1.go create mode 100644 cmd/ordersv2.go create mode 100644 cmd/securecabinetv1.go create mode 100644 cmd/smarthandsv1.go create mode 100644 cmd/stsv1alpha.go create mode 100644 internal/accesstokenv1/accesstokenv1.go create mode 100644 internal/eiav2/eiav2.go create mode 100644 internal/fabricv4/fabricv4.go create mode 100644 internal/lookupv2/lookupv2.go create mode 100644 internal/metalv1/metalv1.go create mode 100644 internal/orderhistoryv1/orderhistoryv1.go create mode 100644 internal/ordersv2/ordersv2.go create mode 100644 internal/securecabinetv1/securecabinetv1.go create mode 100644 internal/smarthandsv1/smarthandsv1.go create mode 100644 internal/stsv1alpha/stsv1alpha.go diff --git a/cmd/accesstokenv1.go b/cmd/accesstokenv1.go new file mode 100644 index 0000000..6d8873b --- /dev/null +++ b/cmd/accesstokenv1.go @@ -0,0 +1,80 @@ +package cmd + +import ( + _ "embed" + "fmt" + "os" + + "github.com/equinix/cli/internal/accesstokenv1" + "github.com/equinix/cli/internal/register" + "github.com/spf13/cobra" +) + +// TODO: Put service subcommands in separate packages to +// avoid variable naming collisions +var accesstokenv1Debug bool + +//go:embed descriptions/accesstokenv1.json +var accesstokenv1Descriptions []byte + +// accesstokenv1Cmd represents the accesstokenv1 command +var accesstokenv1Cmd = &cobra.Command{ + Use: "accesstokenv1", + Short: "Manage Equinix accesstokenv1 resources", + Long: `Commands for managing Equinix accesstokenv1 resources. + +The accesstokenv1 commands are dynamically generated based on the accesstokenv1 API client, +providing access to all available API services.`, + PersistentPreRun: func(cmd *cobra.Command, _ []string) { + // Inject the client factory into the command context so that + // it can be retrieved at execution time + executionClientFactory := func() (register.APIClientInterface, error) { + accesstokenv1.SetDebug(accesstokenv1Debug) + return accesstokenv1.NewClient() + } + cmd.SetContext(register.ContextWithClientFactory(cmd.Context(), executionClientFactory)) + }, +} + +func init() { + rootCmd.AddCommand(accesstokenv1Cmd) + + // Add common debug flag that will be inherited by all subcommands for accesstokenv1 + accesstokenv1Cmd.PersistentFlags().BoolVar(&accesstokenv1Debug, "debug", false, "Enable debug logging for HTTP requests") + + // Add common format flag that will be inherited by all subcommands for accesstokenv1 + accesstokenv1Cmd.PersistentFlags().StringP("format", "f", "json", "Format to use for output (json or yaml)") + + // Load SDK descriptions for better command documentation + if err := register.LoadDescriptions(accesstokenv1Descriptions); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Could not load accesstokenv1 descriptions: %v\n", err) + } + + // Register commands at init time for help/discovery + // We use a discovery client that doesn't require credentials for structure introspection + // Actual API calls will validate credentials at runtime + client, err := accesstokenv1.NewClientForDiscovery() + if err != nil { + // If we can't even create a discovery client, log a warning but continue + // Commands won't be available but the CLI won't crash + fmt.Fprintf(os.Stderr, "Warning: Could not register accesstokenv1 commands: %v\n", err) + return + } + + // Register all service commands dynamically + err = register.ServiceCommands(accesstokenv1Cmd, client, "accesstokenv1") + if err != nil { + fmt.Fprintf(os.Stderr, "Warning: Failed to register accesstokenv1 commands: %v\n", err) + } + + // Uncomment and customize aliases as needed for convenience + // Example: Add shorter aliases for commonly used commands + // accesstokenv1Cmd.Aliases = []string{"accesstoken"} + // + // Or add aliases to specific subcommands after registration: + // if connectionsCmd, _, err := accesstokenv1Cmd.Find([]string{"connections"}); err == nil { + // if createCmd, _, err := connectionsCmd.Find([]string{"create-connection"}); err == nil { + // createCmd.Aliases = []string{"create"} + // } + // } +} diff --git a/cmd/descriptions/accesstokenv1.json b/cmd/descriptions/accesstokenv1.json new file mode 100644 index 0000000..88415ae --- /dev/null +++ b/cmd/descriptions/accesstokenv1.json @@ -0,0 +1,608 @@ +{ + "services": { + "o-auth2-token": { + "service_name": "o-auth2-token", + "service_description": "", + "methods": { + "GetOAuth2AccessToken": { + "short_description": "Generate New Access Token", + "long_description": "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.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetOAuth2AccessTokenExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "RefreshOAuth2AccessToken": { + "short_description": "Renew Access Tokens", + "long_description": "Use this API to refresh an access token using its refresh token. A valid refresh token is needed to retrieve a new access_token.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "RefreshOAuth2AccessTokenExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGetOAuth2AccessTokenRequest": { + "type_name": "ApiGetOAuth2AccessTokenRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "payload": { + "name": "payload", + "description": "" + } + } + }, + "ApiRefreshOAuth2AccessTokenRequest": { + "type_name": "ApiRefreshOAuth2AccessTokenRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "payload": { + "name": "payload", + "description": "" + } + } + } + } + } + }, + "types": { + "APIClient": { + "type_name": "APIClient", + "description": "APIClient manages communication with the Equinix API Authentication API v1.2\nIn most cases there should be only one, shared, APIClient.", + "fields": { + "OAuth2TokenApi": { + "name": "OAuth2TokenApi", + "description": "" + }, + "cfg": { + "name": "cfg", + "description": "" + }, + "common": { + "name": "common", + "description": "Reuse a single struct instead of allocating one for each service on the heap." + } + } + }, + "APIKey": { + "type_name": "APIKey", + "description": "APIKey provides API key based authentication to a request passed via context using ContextAPIKey", + "fields": { + "Key": { + "name": "Key", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "" + } + } + }, + "APIResponse": { + "type_name": "APIResponse", + "description": "APIResponse stores the API response returned by the server.", + "fields": { + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "Method": { + "name": "Method", + "description": "Method is the HTTP method used for the request. This value is always\navailable, even if the embedded *http.Response is nil.", + "json_tag": "method" + }, + "Operation": { + "name": "Operation", + "description": "Operation is the name of the OpenAPI operation.", + "json_tag": "operation" + }, + "Payload": { + "name": "Payload", + "description": "Payload holds the contents of the response body (which may be nil or empty).\nThis is provided here as the raw response.Body() reader will have already\nbeen drained.", + "json_tag": "-" + }, + "RequestURL": { + "name": "RequestURL", + "description": "RequestURL is the request URL. This value is always available, even if the\nembedded *http.Response is nil.", + "json_tag": "url" + } + } + }, + "ApiGetOAuth2AccessTokenRequest": { + "type_name": "ApiGetOAuth2AccessTokenRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "payload": { + "name": "payload", + "description": "" + } + } + }, + "ApiRefreshOAuth2AccessTokenRequest": { + "type_name": "ApiRefreshOAuth2AccessTokenRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "payload": { + "name": "payload", + "description": "" + } + } + }, + "BasicAuth": { + "type_name": "BasicAuth", + "description": "BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth", + "fields": { + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "UserName": { + "name": "UserName", + "description": "", + "json_tag": "userName" + } + } + }, + "Configuration": { + "type_name": "Configuration", + "description": "Configuration stores the configuration of the API client", + "fields": { + "Debug": { + "name": "Debug", + "description": "", + "json_tag": "debug" + }, + "DefaultHeader": { + "name": "DefaultHeader", + "description": "", + "json_tag": "defaultHeader" + }, + "HTTPClient": { + "name": "HTTPClient", + "description": "" + }, + "Host": { + "name": "Host", + "description": "", + "json_tag": "host" + }, + "OperationServers": { + "name": "OperationServers", + "description": "" + }, + "Scheme": { + "name": "Scheme", + "description": "", + "json_tag": "scheme" + }, + "Servers": { + "name": "Servers", + "description": "" + }, + "UserAgent": { + "name": "UserAgent", + "description": "", + "json_tag": "userAgent" + } + } + }, + "GenericOpenAPIError": { + "type_name": "GenericOpenAPIError", + "description": "GenericOpenAPIError Provides access to the body, error and model on returned errors.", + "fields": { + "body": { + "name": "body", + "description": "" + }, + "error": { + "name": "error", + "description": "" + }, + "model": { + "name": "model", + "description": "" + } + } + }, + "NullableBool": { + "type_name": "NullableBool", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat32": { + "type_name": "NullableFloat32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat64": { + "type_name": "NullableFloat64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt": { + "type_name": "NullableInt", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt32": { + "type_name": "NullableInt32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt64": { + "type_name": "NullableInt64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOauth2RefreshTokenRequest": { + "type_name": "NullableOauth2RefreshTokenRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOauth2TokenErrorResponse": { + "type_name": "NullableOauth2TokenErrorResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOauth2TokenRequest": { + "type_name": "NullableOauth2TokenRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOauth2TokenResponse": { + "type_name": "NullableOauth2TokenResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableString": { + "type_name": "NullableString", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTime": { + "type_name": "NullableTime", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "Oauth2RefreshTokenRequest": { + "type_name": "Oauth2RefreshTokenRequest", + "description": "Oauth2RefreshTokenRequest struct for Oauth2RefreshTokenRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ClientId": { + "name": "ClientId", + "description": "API Consumer Key available under \\\"My Apps\\\" in developer portal", + "json_tag": "client_id" + }, + "ClientSecret": { + "name": "ClientSecret", + "description": "API Consumer secret available under \\\"My Apps\\\" in developer portal", + "json_tag": "client_secret" + }, + "RefreshToken": { + "name": "RefreshToken", + "description": "The OAuth2 refresh_token retrieved from the previous successful Access Token API call", + "json_tag": "refresh_token" + } + } + }, + "Oauth2TokenErrorResponse": { + "type_name": "Oauth2TokenErrorResponse", + "description": "Oauth2TokenErrorResponse struct for Oauth2TokenErrorResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeveloperMessage": { + "name": "DeveloperMessage", + "description": "The error message to be used for auditing purpose by the consuming application", + "json_tag": "developer_message" + }, + "ErrorCode": { + "name": "ErrorCode", + "description": "The code used to identify the error category", + "json_tag": "error_code" + }, + "ErrorDomain": { + "name": "ErrorDomain", + "description": "The module associated with this error", + "json_tag": "error_domain" + }, + "ErrorMessage": { + "name": "ErrorMessage", + "description": "The error message which could be displayed to the end user", + "json_tag": "error_message" + }, + "ErrorTitle": { + "name": "ErrorTitle", + "description": "The error title", + "json_tag": "error_title" + } + } + }, + "Oauth2TokenRequest": { + "type_name": "Oauth2TokenRequest", + "description": "Oauth2TokenRequest struct for Oauth2TokenRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ClientId": { + "name": "ClientId", + "description": "API Consumer Key available under \\\"My Apps\\\" in developer portal", + "json_tag": "client_id" + }, + "ClientSecret": { + "name": "ClientSecret", + "description": "API Consumer secret available under \\\"My Apps\\\" in developer portal", + "json_tag": "client_secret" + }, + "GrantType": { + "name": "GrantType", + "description": "The OAuth2 grant type used for authorization. Supported values are \\\"password\\\" \u0026 \\\"client_credentials\\\". user_name and password is not considered in case this value is \\\"client_credentials\\\". If the grant_type is not passed, by default it would consider \\\"password\\\" type in which user_name and password is required. Note that the password grant type is deprecated. Recommended to use grant_type of 'client_credentials' instead.", + "json_tag": "grant_type" + }, + "PasswordEncoding": { + "name": "PasswordEncoding", + "description": "For enhanced security, you may encrypt the password value while requesting for an access_token. Currently only \\\"md5-b64\\\" hashing is supported. Any other value would treat password value as raw string", + "json_tag": "password_encoding" + }, + "UserName": { + "name": "UserName", + "description": "Deprecated - The Equinix username used to access portals", + "json_tag": "user_name" + }, + "UserPassword": { + "name": "UserPassword", + "description": "Deprecated - The Equinix user password used to access portals", + "json_tag": "user_password" + } + } + }, + "Oauth2TokenResponse": { + "type_name": "Oauth2TokenResponse", + "description": "Oauth2TokenResponse struct for Oauth2TokenResponse", + "fields": { + "AccessToken": { + "name": "AccessToken", + "description": "the OAuth2 Bearer token required to access Equinix API's", + "json_tag": "access_token" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "RefreshToken": { + "name": "RefreshToken", + "description": "The OAuth2 refresh token which could be used to retrieve a new access_token without user credentials. The refresh_token has a max validity of 60 days after which a new Access Token request must be made. Refresh token is Not returned for \\\"client_credentials\\\" grant type", + "json_tag": "refresh_token" + }, + "RefreshTokenTimeout": { + "name": "RefreshTokenTimeout", + "description": "The max validity in seconds for the refresh_token. This field is not retruned for the \\\"client_credentials\\\" grant type", + "json_tag": "refresh_token_timeout" + }, + "TokenTimeout": { + "name": "TokenTimeout", + "description": "The max validity in seconds for this access_token", + "json_tag": "token_timeout" + }, + "TokenType": { + "name": "TokenType", + "description": "The type of access_token returned in this response", + "json_tag": "token_type" + }, + "UserName": { + "name": "UserName", + "description": "The Equinix user account to which this token is associated with", + "json_tag": "user_name" + } + } + }, + "ServerConfiguration": { + "type_name": "ServerConfiguration", + "description": "ServerConfiguration stores the information about a server", + "fields": { + "Description": { + "name": "Description", + "description": "" + }, + "URL": { + "name": "URL", + "description": "" + }, + "Variables": { + "name": "Variables", + "description": "" + } + } + }, + "ServerVariable": { + "type_name": "ServerVariable", + "description": "ServerVariable stores the information about a server variable", + "fields": { + "DefaultValue": { + "name": "DefaultValue", + "description": "" + }, + "Description": { + "name": "Description", + "description": "" + }, + "EnumValues": { + "name": "EnumValues", + "description": "" + } + } + }, + "formFile": { + "type_name": "formFile", + "fields": { + "fileBytes": { + "name": "fileBytes", + "description": "" + }, + "fileName": { + "name": "fileName", + "description": "" + }, + "formFileName": { + "name": "formFileName", + "description": "" + } + } + }, + "service": { + "type_name": "service", + "fields": { + "client": { + "name": "client", + "description": "" + } + } + } + } +} \ No newline at end of file diff --git a/cmd/descriptions/eiav2.json b/cmd/descriptions/eiav2.json new file mode 100644 index 0000000..64d7327 --- /dev/null +++ b/cmd/descriptions/eiav2.json @@ -0,0 +1,3741 @@ +{ + "services": { + "eia-service": { + "service_name": "eia-service", + "service_description": "", + "methods": { + "CreateEquinixInternetAccessv2": { + "short_description": "Creates Equinix Internet Access Service", + "long_description": "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", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateEquinixInternetAccessv2Execute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateEquinixInternetAccessv2Request": { + "type_name": "ApiCreateEquinixInternetAccessv2Request", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceRequest": { + "name": "serviceRequest", + "description": "" + } + } + } + } + } + }, + "types": { + "APIClient": { + "type_name": "APIClient", + "description": "APIClient manages communication with the Equinix Internet Access API API v2.0\nIn most cases there should be only one, shared, APIClient.", + "fields": { + "EIAServiceApi": { + "name": "EIAServiceApi", + "description": "" + }, + "cfg": { + "name": "cfg", + "description": "" + }, + "common": { + "name": "common", + "description": "Reuse a single struct instead of allocating one for each service on the heap." + } + } + }, + "APIKey": { + "type_name": "APIKey", + "description": "APIKey provides API key based authentication to a request passed via context using ContextAPIKey", + "fields": { + "Key": { + "name": "Key", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "" + } + } + }, + "APIResponse": { + "type_name": "APIResponse", + "description": "APIResponse stores the API response returned by the server.", + "fields": { + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "Method": { + "name": "Method", + "description": "Method is the HTTP method used for the request. This value is always\navailable, even if the embedded *http.Response is nil.", + "json_tag": "method" + }, + "Operation": { + "name": "Operation", + "description": "Operation is the name of the OpenAPI operation.", + "json_tag": "operation" + }, + "Payload": { + "name": "Payload", + "description": "Payload holds the contents of the response body (which may be nil or empty).\nThis is provided here as the raw response.Body() reader will have already\nbeen drained.", + "json_tag": "-" + }, + "RequestURL": { + "name": "RequestURL", + "description": "RequestURL is the request URL. This value is always available, even if the\nembedded *http.Response is nil.", + "json_tag": "url" + } + } + }, + "AdditionalInfo": { + "type_name": "AdditionalInfo", + "description": "AdditionalInfo Additional info for error", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Property": { + "name": "Property", + "description": "Request property that caused the error", + "json_tag": "property" + }, + "Reason": { + "name": "Reason", + "description": "Reason of the error", + "json_tag": "reason" + } + } + }, + "ApiCreateEquinixInternetAccessv2Request": { + "type_name": "ApiCreateEquinixInternetAccessv2Request", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceRequest": { + "name": "serviceRequest", + "description": "" + } + } + }, + "BasicAuth": { + "type_name": "BasicAuth", + "description": "BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth", + "fields": { + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "UserName": { + "name": "UserName", + "description": "", + "json_tag": "userName" + } + } + }, + "BgpRoutingProtocolRequest": { + "type_name": "BgpRoutingProtocolRequest", + "description": "BgpRoutingProtocolRequest struct for BgpRoutingProtocolRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpAuthKey": { + "name": "BgpAuthKey", + "description": "BGP authentication key", + "json_tag": "bgpAuthKey" + }, + "CustomerAsn": { + "name": "CustomerAsn", + "description": "Customer Autonomous System Number", + "json_tag": "customerAsn" + }, + "CustomerAsnRange": { + "name": "CustomerAsnRange", + "description": "", + "json_tag": "customerAsnRange" + }, + "Description": { + "name": "Description", + "description": "Description of the routing protocol instance", + "json_tag": "description" + }, + "ExportPolicy": { + "name": "ExportPolicy", + "description": "", + "json_tag": "exportPolicy" + }, + "Ipv4": { + "name": "Ipv4", + "description": "", + "json_tag": "ipv4" + }, + "Ipv6": { + "name": "Ipv6", + "description": "", + "json_tag": "ipv6" + }, + "Name": { + "name": "Name", + "description": "Name of the routing protocol instance.", + "json_tag": "name" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "Change": { + "type_name": "Change", + "description": "Change struct for Change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "ChangeLog": { + "type_name": "ChangeLog", + "description": "ChangeLog struct for ChangeLog", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "Account number of the account used for object creation", + "json_tag": "createdBy" + }, + "CreatedByEmail": { + "name": "CreatedByEmail", + "description": "E-mail of the account used for object creation", + "json_tag": "createdByEmail" + }, + "CreatedByFullName": { + "name": "CreatedByFullName", + "description": "Full name of the account used for object creation", + "json_tag": "createdByFullName" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Date and time of object creation", + "json_tag": "createdDateTime" + }, + "DeletedBy": { + "name": "DeletedBy", + "description": "Account number of the account that updated the object last time", + "json_tag": "deletedBy" + }, + "DeletedByEmail": { + "name": "DeletedByEmail", + "description": "E-mail of the account that updated the object last time", + "json_tag": "deletedByEmail" + }, + "DeletedByFullName": { + "name": "DeletedByFullName", + "description": "Full name of the account that updated the object last time", + "json_tag": "deletedByFullName" + }, + "DeletedDateTime": { + "name": "DeletedDateTime", + "description": "Date and time of the account that updated the object last time", + "json_tag": "deletedDateTime" + }, + "UpdatedBy": { + "name": "UpdatedBy", + "description": "Account number of the account that updated the object last time", + "json_tag": "updatedBy" + }, + "UpdatedByEmail": { + "name": "UpdatedByEmail", + "description": "E-mail of the account that updated the object last time", + "json_tag": "updatedByEmail" + }, + "UpdatedByFullName": { + "name": "UpdatedByFullName", + "description": "Full name of the account that updated the object last time", + "json_tag": "updatedByFullName" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "Date and time of the account that updated the object last time", + "json_tag": "updatedDateTime" + } + } + }, + "Configuration": { + "type_name": "Configuration", + "description": "Configuration stores the configuration of the API client", + "fields": { + "Debug": { + "name": "Debug", + "description": "", + "json_tag": "debug" + }, + "DefaultHeader": { + "name": "DefaultHeader", + "description": "", + "json_tag": "defaultHeader" + }, + "HTTPClient": { + "name": "HTTPClient", + "description": "" + }, + "Host": { + "name": "Host", + "description": "", + "json_tag": "host" + }, + "OperationServers": { + "name": "OperationServers", + "description": "" + }, + "Scheme": { + "name": "Scheme", + "description": "", + "json_tag": "scheme" + }, + "Servers": { + "name": "Servers", + "description": "" + }, + "UserAgent": { + "name": "UserAgent", + "description": "", + "json_tag": "userAgent" + } + } + }, + "Contact": { + "type_name": "Contact", + "description": "Contact struct for Contact", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "RegisteredUser": { + "name": "RegisteredUser", + "description": "Identifies (e.g., userName) a registered user. If a registered user is specified, then firstName/lastName need not be provided", + "json_tag": "registeredUser" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ContactRequest": { + "type_name": "ContactRequest", + "description": "ContactRequest struct for ContactRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Availability": { + "name": "Availability", + "description": "", + "json_tag": "availability" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "FirstName": { + "name": "FirstName", + "description": "", + "json_tag": "firstName" + }, + "LastName": { + "name": "LastName", + "description": "", + "json_tag": "lastName" + }, + "Notes": { + "name": "Notes", + "description": "", + "json_tag": "notes" + }, + "Timezone": { + "name": "Timezone", + "description": "", + "json_tag": "timezone" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ContactRequestDetails": { + "type_name": "ContactRequestDetails", + "description": "ContactRequestDetails struct for ContactRequestDetails", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Notes": { + "name": "Notes", + "description": "", + "json_tag": "notes" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Value": { + "name": "Value", + "description": "", + "json_tag": "value" + } + } + }, + "CustomerBillingAccount": { + "type_name": "CustomerBillingAccount", + "description": "CustomerBillingAccount struct for CustomerBillingAccount", + "fields": { + "AccountNumber": { + "name": "AccountNumber", + "description": "Billing account number", + "json_tag": "accountNumber" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + } + } + }, + "CustomerIpBlock": { + "type_name": "CustomerIpBlock", + "description": "CustomerIpBlock struct for CustomerIpBlock", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "PrefixLength": { + "name": "PrefixLength", + "description": "The IPv6 routing prefix, sometimes called a subnet mask, is the network portion of an IP address. The prefix length is an integer between 1 and 128 (inclusive) that represents the number of bits set to 1, such as /24 or /60.", + "json_tag": "prefixLength" + } + } + }, + "CustomerRoute": { + "type_name": "CustomerRoute", + "description": "CustomerRoute struct for CustomerRoute", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "IpBlock": { + "name": "IpBlock", + "description": "", + "json_tag": "ipBlock" + } + } + }, + "CustomerRouteIpv4Request": { + "type_name": "CustomerRouteIpv4Request", + "description": "CustomerRouteIpv4Request struct for CustomerRouteIpv4Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "IpBlock": { + "name": "IpBlock", + "description": "", + "json_tag": "ipBlock" + }, + "Prefix": { + "name": "Prefix", + "description": "Subnet prefix", + "json_tag": "prefix" + } + } + }, + "CustomerRouteIpv6Request": { + "type_name": "CustomerRouteIpv6Request", + "description": "CustomerRouteIpv6Request struct for CustomerRouteIpv6Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "IpBlock": { + "name": "IpBlock", + "description": "", + "json_tag": "ipBlock" + }, + "Prefix": { + "name": "Prefix", + "description": "Subnet prefix", + "json_tag": "prefix" + } + } + }, + "DirectPeeringIpv4Request": { + "type_name": "DirectPeeringIpv4Request", + "description": "DirectPeeringIpv4Request struct for DirectPeeringIpv4Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Connection": { + "name": "Connection", + "description": "", + "json_tag": "connection" + }, + "EquinixPeerIps": { + "name": "EquinixPeerIps", + "description": "Peering IP addresses in Version 4 (IPv4)", + "json_tag": "equinixPeerIps" + }, + "EquinixVRRPIp": { + "name": "EquinixVRRPIp", + "description": "Virtual router group IP addresses in Version 4 (IPv4)", + "json_tag": "equinixVRRPIp" + } + } + }, + "DirectPeeringIpv4RequestConnection": { + "type_name": "DirectPeeringIpv4RequestConnection", + "description": "DirectPeeringIpv4RequestConnection struct for DirectPeeringIpv4RequestConnection", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "DirectPeeringIpv6Request": { + "type_name": "DirectPeeringIpv6Request", + "description": "DirectPeeringIpv6Request struct for DirectPeeringIpv6Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Connection": { + "name": "Connection", + "description": "", + "json_tag": "connection" + }, + "EquinixPeerIps": { + "name": "EquinixPeerIps", + "description": "Peering IP addresses in Version 6 (IPv6)", + "json_tag": "equinixPeerIps" + }, + "EquinixVRRPIp": { + "name": "EquinixVRRPIp", + "description": "Virtual router group IP addresses in Version 6 (IPv6)", + "json_tag": "equinixVRRPIp" + } + } + }, + "DirectRoutingProtocolIpv4Request": { + "type_name": "DirectRoutingProtocolIpv4Request", + "description": "DirectRoutingProtocolIpv4Request struct for DirectRoutingProtocolIpv4Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerRoutes": { + "name": "CustomerRoutes", + "description": "Collection of customer routes of IP Version 4 (IPv4)", + "json_tag": "customerRoutes" + }, + "Peerings": { + "name": "Peerings", + "description": "", + "json_tag": "peerings" + } + } + }, + "DirectRoutingProtocolIpv6Request": { + "type_name": "DirectRoutingProtocolIpv6Request", + "description": "DirectRoutingProtocolIpv6Request struct for DirectRoutingProtocolIpv6Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerRoutes": { + "name": "CustomerRoutes", + "description": "Collection of customer routes of IP Version 6 (IPv6)", + "json_tag": "customerRoutes" + }, + "Peerings": { + "name": "Peerings", + "description": "", + "json_tag": "peerings" + } + } + }, + "DirectRoutingProtocolRequest": { + "type_name": "DirectRoutingProtocolRequest", + "description": "DirectRoutingProtocolRequest struct for DirectRoutingProtocolRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Description of the routing protocol instance", + "json_tag": "description" + }, + "Ipv4": { + "name": "Ipv4", + "description": "", + "json_tag": "ipv4" + }, + "Ipv6": { + "name": "Ipv6", + "description": "", + "json_tag": "ipv6" + }, + "Name": { + "name": "Name", + "description": "Name of the routing protocol instance.", + "json_tag": "name" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "EntityReference": { + "type_name": "EntityReference", + "description": "EntityReference struct for EntityReference", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + } + } + }, + "Error": { + "type_name": "Error", + "description": "Error Error Response with details", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Collection of additional information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CorrelationId": { + "name": "CorrelationId", + "description": "Correlation ID identifying the request", + "json_tag": "correlationId" + }, + "Details": { + "name": "Details", + "description": "Error details", + "json_tag": "details" + }, + "ErrorCode": { + "name": "ErrorCode", + "description": "Error code", + "json_tag": "errorCode\" validate:\"regexp=^EQ-\\\\\\\\d{7}$" + }, + "ErrorMessage": { + "name": "ErrorMessage", + "description": "Error message", + "json_tag": "errorMessage" + }, + "Help": { + "name": "Help", + "description": "Link to the help information", + "json_tag": "help" + } + } + }, + "ErrorAdditionalInfo": { + "type_name": "ErrorAdditionalInfo", + "description": "ErrorAdditionalInfo Additional info for error", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Property": { + "name": "Property", + "description": "Request property that caused the error", + "json_tag": "property" + }, + "Reason": { + "name": "Reason", + "description": "Reason of the error", + "json_tag": "reason" + } + } + }, + "GenericOpenAPIError": { + "type_name": "GenericOpenAPIError", + "description": "GenericOpenAPIError Provides access to the body, error and model on returned errors.", + "fields": { + "body": { + "name": "body", + "description": "" + }, + "error": { + "name": "error", + "description": "" + }, + "model": { + "name": "model", + "description": "" + } + } + }, + "IpBlock": { + "type_name": "IpBlock", + "description": "IpBlock struct for IpBlock", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AddressingPlans": { + "name": "AddressingPlans", + "description": "Collection of addressing plans", + "json_tag": "addressingPlans" + }, + "Questions": { + "name": "Questions", + "description": "Connection of questions", + "json_tag": "questions" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "IpBlockAddressingPlans": { + "type_name": "IpBlockAddressingPlans", + "description": "IpBlockAddressingPlans struct for IpBlockAddressingPlans", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AfterThreeMonths": { + "name": "AfterThreeMonths", + "description": "Number of ip addresses to be used after 3 months", + "json_tag": "afterThreeMonths" + }, + "Immediate": { + "name": "Immediate", + "description": "Number of ip addresses to be used immediatelly", + "json_tag": "immediate" + }, + "Purpose": { + "name": "Purpose", + "description": "The purpose of IP Subnet", + "json_tag": "purpose" + }, + "Size": { + "name": "Size", + "description": "", + "json_tag": "size" + } + } + }, + "IpBlockIpv4Request": { + "type_name": "IpBlockIpv4Request", + "description": "IpBlockIpv4Request struct for IpBlockIpv4Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AddressingPlans": { + "name": "AddressingPlans", + "description": "Collection of addressing plans", + "json_tag": "addressingPlans" + }, + "PrefixLength": { + "name": "PrefixLength", + "description": "Length of the IP block, number after the / (slash)", + "json_tag": "prefixLength" + }, + "Questions": { + "name": "Questions", + "description": "Connection of questions", + "json_tag": "questions" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "IpBlockIpv6Request": { + "type_name": "IpBlockIpv6Request", + "description": "IpBlockIpv6Request struct for IpBlockIpv6Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AddressingPlans": { + "name": "AddressingPlans", + "description": "Collection of addressing plans", + "json_tag": "addressingPlans" + }, + "PrefixLength": { + "name": "PrefixLength", + "description": "Length of the IP block, number after the / (slash)", + "json_tag": "prefixLength" + }, + "Questions": { + "name": "Questions", + "description": "Connection of questions", + "json_tag": "questions" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "IpBlockQuestions": { + "type_name": "IpBlockQuestions", + "description": "IpBlockQuestions struct for IpBlockQuestions", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Answer": { + "name": "Answer", + "description": "", + "json_tag": "answer" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "IpBlockReadModel": { + "type_name": "IpBlockReadModel", + "description": "IpBlockReadModel struct for IpBlockReadModel", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Ip block URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "Link": { + "type_name": "Link", + "description": "Link struct for Link", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Authenticate": { + "name": "Authenticate", + "description": "", + "json_tag": "authenticate" + }, + "ContentType": { + "name": "ContentType", + "description": "", + "json_tag": "contentType" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Method": { + "name": "Method", + "description": "", + "json_tag": "method" + }, + "Rel": { + "name": "Rel", + "description": "self, info, update, delete, statistics, events", + "json_tag": "rel" + } + } + }, + "NullableAdditionalInfo": { + "type_name": "NullableAdditionalInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpRoutingProtocolRequest": { + "type_name": "NullableBgpRoutingProtocolRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpRoutingProtocolRequestAllOfCustomerAsnRange": { + "type_name": "NullableBgpRoutingProtocolRequestAllOfCustomerAsnRange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpRoutingProtocolRequestAllOfExportPolicy": { + "type_name": "NullableBgpRoutingProtocolRequestAllOfExportPolicy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBillingType": { + "type_name": "NullableBillingType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBool": { + "type_name": "NullableBool", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableChange": { + "type_name": "NullableChange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableChangeLog": { + "type_name": "NullableChangeLog", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableChangeType": { + "type_name": "NullableChangeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionType": { + "type_name": "NullableConnectionType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContact": { + "type_name": "NullableContact", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactRequest": { + "type_name": "NullableContactRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactRequestAvailability": { + "type_name": "NullableContactRequestAvailability", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactRequestDetails": { + "type_name": "NullableContactRequestDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactRequestDetailsType": { + "type_name": "NullableContactRequestDetailsType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactType": { + "type_name": "NullableContactType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCustomerBillingAccount": { + "type_name": "NullableCustomerBillingAccount", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCustomerIpBlock": { + "type_name": "NullableCustomerIpBlock", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCustomerRoute": { + "type_name": "NullableCustomerRoute", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCustomerRouteIpv4Request": { + "type_name": "NullableCustomerRouteIpv4Request", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCustomerRouteIpv6Request": { + "type_name": "NullableCustomerRouteIpv6Request", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDirectPeeringIpv4Request": { + "type_name": "NullableDirectPeeringIpv4Request", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDirectPeeringIpv4RequestConnection": { + "type_name": "NullableDirectPeeringIpv4RequestConnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDirectPeeringIpv6Request": { + "type_name": "NullableDirectPeeringIpv6Request", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDirectRoutingProtocolIpv4Request": { + "type_name": "NullableDirectRoutingProtocolIpv4Request", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDirectRoutingProtocolIpv6Request": { + "type_name": "NullableDirectRoutingProtocolIpv6Request", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDirectRoutingProtocolRequest": { + "type_name": "NullableDirectRoutingProtocolRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableEntityReference": { + "type_name": "NullableEntityReference", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableError": { + "type_name": "NullableError", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableErrorAdditionalInfo": { + "type_name": "NullableErrorAdditionalInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableExportPolicy": { + "type_name": "NullableExportPolicy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat32": { + "type_name": "NullableFloat32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat64": { + "type_name": "NullableFloat64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt": { + "type_name": "NullableInt", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt32": { + "type_name": "NullableInt32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt64": { + "type_name": "NullableInt64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpBlock": { + "type_name": "NullableIpBlock", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpBlockAddressingPlans": { + "type_name": "NullableIpBlockAddressingPlans", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpBlockIpv4Request": { + "type_name": "NullableIpBlockIpv4Request", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpBlockIpv6Request": { + "type_name": "NullableIpBlockIpv6Request", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpBlockQuestions": { + "type_name": "NullableIpBlockQuestions", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpBlockQuestionsAnswer": { + "type_name": "NullableIpBlockQuestionsAnswer", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpBlockQuestionsType": { + "type_name": "NullableIpBlockQuestionsType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpBlockReadModel": { + "type_name": "NullableIpBlockReadModel", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpBlockReadModelType": { + "type_name": "NullableIpBlockReadModelType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLink": { + "type_name": "NullableLink", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrder": { + "type_name": "NullableOrder", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderChangeLog": { + "type_name": "NullableOrderChangeLog", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderPurchaseOrder": { + "type_name": "NullableOrderPurchaseOrder", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderPurchaseOrderAllOfType": { + "type_name": "NullableOrderPurchaseOrderAllOfType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderSignature": { + "type_name": "NullableOrderSignature", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderSignatureDelegate": { + "type_name": "NullableOrderSignatureDelegate", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderSignatureDelegateRequest": { + "type_name": "NullableOrderSignatureDelegateRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderSignatureRequest": { + "type_name": "NullableOrderSignatureRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderSignatureSignatory": { + "type_name": "NullableOrderSignatureSignatory", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderState": { + "type_name": "NullableOrderState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderType": { + "type_name": "NullableOrderType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProject": { + "type_name": "NullableProject", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProjectReference": { + "type_name": "NullableProjectReference", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePurchaseOrderType": { + "type_name": "NullablePurchaseOrderType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocol": { + "type_name": "NullableRoutingProtocol", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolBgp": { + "type_name": "NullableRoutingProtocolBgp", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolBgpAdditionalFields": { + "type_name": "NullableRoutingProtocolBgpAdditionalFields", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolCustomerRouteIpv4": { + "type_name": "NullableRoutingProtocolCustomerRouteIpv4", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolCustomerRouteIpv6": { + "type_name": "NullableRoutingProtocolCustomerRouteIpv6", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolDirect": { + "type_name": "NullableRoutingProtocolDirect", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolIpBlock": { + "type_name": "NullableRoutingProtocolIpBlock", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolIpv4": { + "type_name": "NullableRoutingProtocolIpv4", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolIpv4Request": { + "type_name": "NullableRoutingProtocolIpv4Request", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolIpv6": { + "type_name": "NullableRoutingProtocolIpv6", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolIpv6Request": { + "type_name": "NullableRoutingProtocolIpv6Request", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolPeeringConnectionItem": { + "type_name": "NullableRoutingProtocolPeeringConnectionItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolPeeringIpv4": { + "type_name": "NullableRoutingProtocolPeeringIpv4", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolPeeringIpv4PeerSubnet": { + "type_name": "NullableRoutingProtocolPeeringIpv4PeerSubnet", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolPeeringIpv6": { + "type_name": "NullableRoutingProtocolPeeringIpv6", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolPeeringIpv6PeerSubnet": { + "type_name": "NullableRoutingProtocolPeeringIpv6PeerSubnet", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolReadModel": { + "type_name": "NullableRoutingProtocolReadModel", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolRequest": { + "type_name": "NullableRoutingProtocolRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolStatic": { + "type_name": "NullableRoutingProtocolStatic", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolType": { + "type_name": "NullableRoutingProtocolType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableService": { + "type_name": "NullableService", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceBase": { + "type_name": "NullableServiceBase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceBilling": { + "type_name": "NullableServiceBilling", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceChangeLog": { + "type_name": "NullableServiceChangeLog", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceOrderContact": { + "type_name": "NullableServiceOrderContact", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceOrderReference": { + "type_name": "NullableServiceOrderReference", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceOrderRequest": { + "type_name": "NullableServiceOrderRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceOrderType": { + "type_name": "NullableServiceOrderType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServicePurchaseOrder": { + "type_name": "NullableServicePurchaseOrder", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServicePurchaseOrderAttachment": { + "type_name": "NullableServicePurchaseOrderAttachment", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceRequest": { + "type_name": "NullableServiceRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceRequestAllOfRoutingProtocol": { + "type_name": "NullableServiceRequestAllOfRoutingProtocol", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceState": { + "type_name": "NullableServiceState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceType": { + "type_name": "NullableServiceType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTypeV2": { + "type_name": "NullableServiceTypeV2", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceUseCase": { + "type_name": "NullableServiceUseCase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceV2": { + "type_name": "NullableServiceV2", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStaticRoutingProtocolRequest": { + "type_name": "NullableStaticRoutingProtocolRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableString": { + "type_name": "NullableString", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTaggable": { + "type_name": "NullableTaggable", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTime": { + "type_name": "NullableTime", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUniqueEntityReference": { + "type_name": "NullableUniqueEntityReference", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUseCaseType": { + "type_name": "NullableUseCaseType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "Order": { + "type_name": "Order", + "description": "Order struct for Order", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Contacts": { + "name": "Contacts", + "description": "", + "json_tag": "contacts" + }, + "Draft": { + "name": "Draft", + "description": "", + "json_tag": "draft" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Links": { + "name": "Links", + "description": "", + "json_tag": "links" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "ReferenceNumber": { + "name": "ReferenceNumber", + "description": "", + "json_tag": "referenceNumber" + }, + "Signature": { + "name": "Signature", + "description": "", + "json_tag": "signature" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "OrderChangeLog": { + "type_name": "OrderChangeLog", + "description": "OrderChangeLog struct for OrderChangeLog", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "", + "json_tag": "createdBy" + }, + "CreatedByEmail": { + "name": "CreatedByEmail", + "description": "", + "json_tag": "createdByEmail" + }, + "CreatedByFullName": { + "name": "CreatedByFullName", + "description": "", + "json_tag": "createdByFullName" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "", + "json_tag": "createdDateTime" + }, + "DeletedBy": { + "name": "DeletedBy", + "description": "", + "json_tag": "deletedBy" + }, + "DeletedByEmail": { + "name": "DeletedByEmail", + "description": "", + "json_tag": "deletedByEmail" + }, + "DeletedByFullName": { + "name": "DeletedByFullName", + "description": "", + "json_tag": "deletedByFullName" + }, + "DeletedDateTime": { + "name": "DeletedDateTime", + "description": "", + "json_tag": "deletedDateTime" + }, + "UpdatedBy": { + "name": "UpdatedBy", + "description": "", + "json_tag": "updatedBy" + }, + "UpdatedByEmail": { + "name": "UpdatedByEmail", + "description": "", + "json_tag": "updatedByEmail" + }, + "UpdatedByFullName": { + "name": "UpdatedByFullName", + "description": "", + "json_tag": "updatedByFullName" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "", + "json_tag": "updatedDateTime" + } + } + }, + "OrderPurchaseOrder": { + "type_name": "OrderPurchaseOrder", + "description": "OrderPurchaseOrder struct for OrderPurchaseOrder", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Number": { + "name": "Number", + "description": "", + "json_tag": "number" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "OrderSignature": { + "type_name": "OrderSignature", + "description": "OrderSignature struct for OrderSignature", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Delegate": { + "name": "Delegate", + "description": "", + "json_tag": "delegate" + }, + "Signatory": { + "name": "Signatory", + "description": "", + "json_tag": "signatory" + } + } + }, + "OrderSignatureDelegate": { + "type_name": "OrderSignatureDelegate", + "description": "OrderSignatureDelegate struct for OrderSignatureDelegate", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Email": { + "name": "Email", + "description": "Email address that the signature request should be sent to in case of DELEGATE signature", + "json_tag": "email" + }, + "FirstName": { + "name": "FirstName", + "description": "", + "json_tag": "firstName" + }, + "LastName": { + "name": "LastName", + "description": "", + "json_tag": "lastName" + } + } + }, + "OrderSignatureDelegateRequest": { + "type_name": "OrderSignatureDelegateRequest", + "description": "OrderSignatureDelegateRequest struct for OrderSignatureDelegateRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Email": { + "name": "Email", + "description": "Email address that the signature request should be sent to in case of DELEGATE signature", + "json_tag": "email" + }, + "FirstName": { + "name": "FirstName", + "description": "", + "json_tag": "firstName" + }, + "LastName": { + "name": "LastName", + "description": "", + "json_tag": "lastName" + } + } + }, + "OrderSignatureRequest": { + "type_name": "OrderSignatureRequest", + "description": "OrderSignatureRequest struct for OrderSignatureRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Delegate": { + "name": "Delegate", + "description": "", + "json_tag": "delegate" + }, + "Signatory": { + "name": "Signatory", + "description": "", + "json_tag": "signatory" + } + } + }, + "Project": { + "type_name": "Project", + "description": "Project struct for Project", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ProjectId": { + "name": "ProjectId", + "description": "Customer Resource Hierarchy Project identifier", + "json_tag": "projectId" + } + } + }, + "ProjectReference": { + "type_name": "ProjectReference", + "description": "ProjectReference struct for ProjectReference", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "ProjectId": { + "name": "ProjectId", + "description": "Customer Resource Hierarchy Project identifier", + "json_tag": "projectId" + } + } + }, + "RoutingProtocol": { + "type_name": "RoutingProtocol", + "description": "RoutingProtocol struct for RoutingProtocol", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Ipv4": { + "name": "Ipv4", + "description": "", + "json_tag": "ipv4" + }, + "Ipv6": { + "name": "Ipv6", + "description": "", + "json_tag": "ipv6" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "RoutingProtocolBgp": { + "type_name": "RoutingProtocolBgp", + "description": "RoutingProtocolBgp struct for RoutingProtocolBgp", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpAuthKey": { + "name": "BgpAuthKey", + "description": "BGP authentication key", + "json_tag": "bgpAuthKey" + }, + "CustomerAsn": { + "name": "CustomerAsn", + "description": "Customer Autonomous System Number", + "json_tag": "customerAsn" + }, + "CustomerAsnRange": { + "name": "CustomerAsnRange", + "description": "", + "json_tag": "customerAsnRange" + }, + "EquinixAsn": { + "name": "EquinixAsn", + "description": "Equinix Autonomous System Number", + "json_tag": "equinixAsn" + }, + "ExportPolicy": { + "name": "ExportPolicy", + "description": "", + "json_tag": "exportPolicy" + } + } + }, + "RoutingProtocolBgpAdditionalFields": { + "type_name": "RoutingProtocolBgpAdditionalFields", + "description": "RoutingProtocolBgpAdditionalFields BGP routing protocol", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpAuthKey": { + "name": "BgpAuthKey", + "description": "BGP authentication key", + "json_tag": "bgpAuthKey" + }, + "CustomerAsn": { + "name": "CustomerAsn", + "description": "Customer Autonomous System Number", + "json_tag": "customerAsn" + }, + "CustomerAsnRange": { + "name": "CustomerAsnRange", + "description": "", + "json_tag": "customerAsnRange" + }, + "EquinixAsn": { + "name": "EquinixAsn", + "description": "Equinix Autonomous System Number", + "json_tag": "equinixAsn" + }, + "ExportPolicy": { + "name": "ExportPolicy", + "description": "", + "json_tag": "exportPolicy" + } + } + }, + "RoutingProtocolCustomerRouteIpv4": { + "type_name": "RoutingProtocolCustomerRouteIpv4", + "description": "RoutingProtocolCustomerRouteIpv4 struct for RoutingProtocolCustomerRouteIpv4", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ImportPolicy": { + "name": "ImportPolicy", + "description": "", + "json_tag": "importPolicy" + }, + "IpBlock": { + "name": "IpBlock", + "description": "", + "json_tag": "ipBlock" + }, + "Prefix": { + "name": "Prefix", + "description": "Subnet prefix", + "json_tag": "prefix" + }, + "PrefixLength": { + "name": "PrefixLength", + "description": "Determines the size of ip subnet", + "json_tag": "prefixLength" + } + } + }, + "RoutingProtocolCustomerRouteIpv6": { + "type_name": "RoutingProtocolCustomerRouteIpv6", + "description": "RoutingProtocolCustomerRouteIpv6 struct for RoutingProtocolCustomerRouteIpv6", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ImportPolicy": { + "name": "ImportPolicy", + "description": "", + "json_tag": "importPolicy" + }, + "IpBlock": { + "name": "IpBlock", + "description": "", + "json_tag": "ipBlock" + }, + "Prefix": { + "name": "Prefix", + "description": "Subnet prefix", + "json_tag": "prefix" + }, + "PrefixLength": { + "name": "PrefixLength", + "description": "Determines the size of ip subnet", + "json_tag": "prefixLength" + } + } + }, + "RoutingProtocolDirect": { + "type_name": "RoutingProtocolDirect", + "description": "RoutingProtocolDirect struct for RoutingProtocolDirect", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + } + } + }, + "RoutingProtocolIpBlock": { + "type_name": "RoutingProtocolIpBlock", + "description": "RoutingProtocolIpBlock struct for RoutingProtocolIpBlock", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerRoute": { + "name": "CustomerRoute", + "description": "", + "json_tag": "customerRoute" + } + } + }, + "RoutingProtocolIpv4": { + "type_name": "RoutingProtocolIpv4", + "description": "RoutingProtocolIpv4 struct for RoutingProtocolIpv4", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerRoutes": { + "name": "CustomerRoutes", + "description": "", + "json_tag": "customerRoutes" + }, + "Peerings": { + "name": "Peerings", + "description": "", + "json_tag": "peerings" + } + } + }, + "RoutingProtocolIpv4Request": { + "type_name": "RoutingProtocolIpv4Request", + "description": "RoutingProtocolIpv4Request struct for RoutingProtocolIpv4Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerRoutes": { + "name": "CustomerRoutes", + "description": "Collection of customer routes of IP Version 4 (IPv4)", + "json_tag": "customerRoutes" + } + } + }, + "RoutingProtocolIpv6": { + "type_name": "RoutingProtocolIpv6", + "description": "RoutingProtocolIpv6 struct for RoutingProtocolIpv6", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerRoutes": { + "name": "CustomerRoutes", + "description": "", + "json_tag": "customerRoutes" + }, + "Peerings": { + "name": "Peerings", + "description": "", + "json_tag": "peerings" + } + } + }, + "RoutingProtocolIpv6Request": { + "type_name": "RoutingProtocolIpv6Request", + "description": "RoutingProtocolIpv6Request struct for RoutingProtocolIpv6Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerRoutes": { + "name": "CustomerRoutes", + "description": "Collection of customer routes of IP Version 6 (IPv6)", + "json_tag": "customerRoutes" + } + } + }, + "RoutingProtocolPeeringConnectionItem": { + "type_name": "RoutingProtocolPeeringConnectionItem", + "description": "RoutingProtocolPeeringConnectionItem struct for RoutingProtocolPeeringConnectionItem", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Ip block URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "RoutingProtocolPeeringIpv4": { + "type_name": "RoutingProtocolPeeringIpv4", + "description": "RoutingProtocolPeeringIpv4 struct for RoutingProtocolPeeringIpv4", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Connections": { + "name": "Connections", + "description": "", + "json_tag": "connections" + }, + "CustomerPeerIps": { + "name": "CustomerPeerIps", + "description": "", + "json_tag": "customerPeerIps" + }, + "CustomerVRRPIp": { + "name": "CustomerVRRPIp", + "description": "", + "json_tag": "customerVRRPIp" + }, + "EquinixPeerIps": { + "name": "EquinixPeerIps", + "description": "", + "json_tag": "equinixPeerIps" + }, + "EquinixVRRPIp": { + "name": "EquinixVRRPIp", + "description": "", + "json_tag": "equinixVRRPIp" + }, + "PeerSubnet": { + "name": "PeerSubnet", + "description": "", + "json_tag": "peerSubnet" + }, + "VrrpEnabled": { + "name": "VrrpEnabled", + "description": "Indicates if VRRP is enabled.", + "json_tag": "vrrpEnabled" + } + } + }, + "RoutingProtocolPeeringIpv4PeerSubnet": { + "type_name": "RoutingProtocolPeeringIpv4PeerSubnet", + "description": "RoutingProtocolPeeringIpv4PeerSubnet struct for RoutingProtocolPeeringIpv4PeerSubnet", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "Subnet used for peering", + "json_tag": "prefix" + }, + "PrefixLength": { + "name": "PrefixLength", + "description": "", + "json_tag": "prefixLength" + } + } + }, + "RoutingProtocolPeeringIpv6": { + "type_name": "RoutingProtocolPeeringIpv6", + "description": "RoutingProtocolPeeringIpv6 struct for RoutingProtocolPeeringIpv6", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Connections": { + "name": "Connections", + "description": "", + "json_tag": "connections" + }, + "CustomerPeerIps": { + "name": "CustomerPeerIps", + "description": "", + "json_tag": "customerPeerIps" + }, + "CustomerVRRPIp": { + "name": "CustomerVRRPIp", + "description": "", + "json_tag": "customerVRRPIp" + }, + "EquinixPeerIps": { + "name": "EquinixPeerIps", + "description": "", + "json_tag": "equinixPeerIps" + }, + "EquinixVRRPIp": { + "name": "EquinixVRRPIp", + "description": "", + "json_tag": "equinixVRRPIp" + }, + "PeerSubnet": { + "name": "PeerSubnet", + "description": "", + "json_tag": "peerSubnet" + }, + "VrrpEnabled": { + "name": "VrrpEnabled", + "description": "Indicates if VRRP is enabled.", + "json_tag": "vrrpEnabled" + } + } + }, + "RoutingProtocolPeeringIpv6PeerSubnet": { + "type_name": "RoutingProtocolPeeringIpv6PeerSubnet", + "description": "RoutingProtocolPeeringIpv6PeerSubnet struct for RoutingProtocolPeeringIpv6PeerSubnet", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "Subnet used for peering", + "json_tag": "prefix" + }, + "PrefixLength": { + "name": "PrefixLength", + "description": "", + "json_tag": "prefixLength" + } + } + }, + "RoutingProtocolReadModel": { + "type_name": "RoutingProtocolReadModel", + "description": "RoutingProtocolReadModel struct for RoutingProtocolReadModel", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Description": { + "name": "Description", + "description": "Description of the routing protocol instance", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Routing protocol URI", + "json_tag": "href" + }, + "Ipv4": { + "name": "Ipv4", + "description": "", + "json_tag": "ipv4" + }, + "Ipv6": { + "name": "Ipv6", + "description": "", + "json_tag": "ipv6" + }, + "Links": { + "name": "Links", + "description": "", + "json_tag": "links" + }, + "Name": { + "name": "Name", + "description": "Name of the routing protocol instance.", + "json_tag": "name" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Routing protocol identifier", + "json_tag": "uuid" + } + } + }, + "RoutingProtocolRequest": { + "type_name": "RoutingProtocolRequest", + "description": "RoutingProtocolRequest struct for RoutingProtocolRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Description of the routing protocol instance", + "json_tag": "description" + }, + "Name": { + "name": "Name", + "description": "Name of the routing protocol instance.", + "json_tag": "name" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "RoutingProtocolStatic": { + "type_name": "RoutingProtocolStatic", + "description": "RoutingProtocolStatic struct for RoutingProtocolStatic", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + } + } + }, + "ServerConfiguration": { + "type_name": "ServerConfiguration", + "description": "ServerConfiguration stores the information about a server", + "fields": { + "Description": { + "name": "Description", + "description": "" + }, + "URL": { + "name": "URL", + "description": "" + }, + "Variables": { + "name": "Variables", + "description": "" + } + } + }, + "ServerVariable": { + "type_name": "ServerVariable", + "description": "ServerVariable stores the information about a server variable", + "fields": { + "DefaultValue": { + "name": "DefaultValue", + "description": "" + }, + "Description": { + "name": "Description", + "description": "" + }, + "EnumValues": { + "name": "EnumValues", + "description": "" + } + } + }, + "Service": { + "type_name": "Service", + "description": "Service struct for Service", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Service bandwidth in Mbps", + "json_tag": "bandwidth" + }, + "Billing": { + "name": "Billing", + "description": "", + "json_tag": "billing" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Description": { + "name": "Description", + "description": "Description of the service instance", + "json_tag": "description" + }, + "Draft": { + "name": "Draft", + "description": "", + "json_tag": "draft" + }, + "Links": { + "name": "Links", + "description": "", + "json_tag": "links" + }, + "MinBandwidthCommit": { + "name": "MinBandwidthCommit", + "description": "Service min bandwidth commit in Mbps", + "json_tag": "minBandwidthCommit" + }, + "Name": { + "name": "Name", + "description": "Name of the service instance", + "json_tag": "name" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UseCase": { + "name": "UseCase", + "description": "", + "json_tag": "useCase" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "ServiceBase": { + "type_name": "ServiceBase", + "description": "ServiceBase struct for ServiceBase", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Service bandwidth in Mbps", + "json_tag": "bandwidth" + }, + "Description": { + "name": "Description", + "description": "Description of the service instance", + "json_tag": "description" + }, + "MinBandwidthCommit": { + "name": "MinBandwidthCommit", + "description": "Service min bandwidth commit in Mbps", + "json_tag": "minBandwidthCommit" + }, + "Name": { + "name": "Name", + "description": "Name of the service instance", + "json_tag": "name" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UseCase": { + "name": "UseCase", + "description": "", + "json_tag": "useCase" + } + } + }, + "ServiceChangeLog": { + "type_name": "ServiceChangeLog", + "description": "ServiceChangeLog struct for ServiceChangeLog", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "", + "json_tag": "createdBy" + }, + "CreatedByEmail": { + "name": "CreatedByEmail", + "description": "", + "json_tag": "createdByEmail" + }, + "CreatedByFullName": { + "name": "CreatedByFullName", + "description": "", + "json_tag": "createdByFullName" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "", + "json_tag": "createdDateTime" + }, + "DeletedBy": { + "name": "DeletedBy", + "description": "", + "json_tag": "deletedBy" + }, + "DeletedByEmail": { + "name": "DeletedByEmail", + "description": "", + "json_tag": "deletedByEmail" + }, + "DeletedByFullName": { + "name": "DeletedByFullName", + "description": "", + "json_tag": "deletedByFullName" + }, + "DeletedDateTime": { + "name": "DeletedDateTime", + "description": "", + "json_tag": "deletedDateTime" + }, + "UpdatedBy": { + "name": "UpdatedBy", + "description": "", + "json_tag": "updatedBy" + }, + "UpdatedByEmail": { + "name": "UpdatedByEmail", + "description": "", + "json_tag": "updatedByEmail" + }, + "UpdatedByFullName": { + "name": "UpdatedByFullName", + "description": "", + "json_tag": "updatedByFullName" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "", + "json_tag": "updatedDateTime" + } + } + }, + "ServiceOrderContact": { + "type_name": "ServiceOrderContact", + "description": "ServiceOrderContact struct for ServiceOrderContact", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Availability": { + "name": "Availability", + "description": "", + "json_tag": "availability" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "FirstName": { + "name": "FirstName", + "description": "", + "json_tag": "firstName" + }, + "LastName": { + "name": "LastName", + "description": "", + "json_tag": "lastName" + }, + "Notes": { + "name": "Notes", + "description": "", + "json_tag": "notes" + }, + "RegisteredUser": { + "name": "RegisteredUser", + "description": "Identifies (e.g., userName) a registered user. If a registered user is specified, then firstName/lastName need not be provided", + "json_tag": "registeredUser" + }, + "Timezone": { + "name": "Timezone", + "description": "", + "json_tag": "timezone" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ServiceOrderReference": { + "type_name": "ServiceOrderReference", + "description": "ServiceOrderReference struct for ServiceOrderReference", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "ServiceOrderRequest": { + "type_name": "ServiceOrderRequest", + "description": "ServiceOrderRequest struct for ServiceOrderRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Contacts": { + "name": "Contacts", + "description": "", + "json_tag": "contacts" + }, + "Draft": { + "name": "Draft", + "description": "", + "json_tag": "draft" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "ReferenceNumber": { + "name": "ReferenceNumber", + "description": "", + "json_tag": "referenceNumber" + }, + "Signature": { + "name": "Signature", + "description": "", + "json_tag": "signature" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "ServicePurchaseOrder": { + "type_name": "ServicePurchaseOrder", + "description": "ServicePurchaseOrder struct for ServicePurchaseOrder", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Amount": { + "name": "Amount", + "description": "Amount", + "json_tag": "amount" + }, + "Attachment": { + "name": "Attachment", + "description": "", + "json_tag": "attachment" + }, + "Description": { + "name": "Description", + "description": "Purchase order description", + "json_tag": "description" + }, + "EndDate": { + "name": "EndDate", + "description": "End date in YYYY-MM-DD format", + "json_tag": "endDate" + }, + "Number": { + "name": "Number", + "description": "Purchase order number", + "json_tag": "number" + }, + "StartDate": { + "name": "StartDate", + "description": "Start date in YYYY-MM-DD format", + "json_tag": "startDate" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ServicePurchaseOrderAttachment": { + "type_name": "ServicePurchaseOrderAttachment", + "description": "ServicePurchaseOrderAttachment struct for ServicePurchaseOrderAttachment", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AttachmentId": { + "name": "AttachmentId", + "description": "", + "json_tag": "attachmentId" + } + } + }, + "ServiceRequest": { + "type_name": "ServiceRequest", + "description": "ServiceRequest struct for ServiceRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Connections": { + "name": "Connections", + "description": "Collection of service connections uuids", + "json_tag": "connections" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "RoutingProtocol": { + "name": "RoutingProtocol", + "description": "", + "json_tag": "routingProtocol" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ServiceRequestAllOfRoutingProtocol": { + "type_name": "ServiceRequestAllOfRoutingProtocol", + "description": "ServiceRequestAllOfRoutingProtocol - struct for ServiceRequestAllOfRoutingProtocol", + "fields": { + "BgpRoutingProtocolRequest": { + "name": "BgpRoutingProtocolRequest", + "description": "" + }, + "DirectRoutingProtocolRequest": { + "name": "DirectRoutingProtocolRequest", + "description": "" + }, + "StaticRoutingProtocolRequest": { + "name": "StaticRoutingProtocolRequest", + "description": "" + } + } + }, + "ServiceV2": { + "type_name": "ServiceV2", + "description": "ServiceV2 struct for ServiceV2", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Service bandwidth in Mbps", + "json_tag": "bandwidth" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Links": { + "name": "Links", + "description": "", + "json_tag": "links" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "StaticRoutingProtocolRequest": { + "type_name": "StaticRoutingProtocolRequest", + "description": "StaticRoutingProtocolRequest struct for StaticRoutingProtocolRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Description of the routing protocol instance", + "json_tag": "description" + }, + "Ipv4": { + "name": "Ipv4", + "description": "", + "json_tag": "ipv4" + }, + "Ipv6": { + "name": "Ipv6", + "description": "", + "json_tag": "ipv6" + }, + "Name": { + "name": "Name", + "description": "Name of the routing protocol instance.", + "json_tag": "name" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "Taggable": { + "type_name": "Taggable", + "description": "Taggable struct for Taggable", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "UniqueEntityReference": { + "type_name": "UniqueEntityReference", + "description": "UniqueEntityReference struct for UniqueEntityReference", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "formFile": { + "type_name": "formFile", + "fields": { + "fileBytes": { + "name": "fileBytes", + "description": "" + }, + "fileName": { + "name": "fileName", + "description": "" + }, + "formFileName": { + "name": "formFileName", + "description": "" + } + } + }, + "service": { + "type_name": "service", + "fields": { + "client": { + "name": "client", + "description": "" + } + } + } + } +} \ No newline at end of file diff --git a/cmd/descriptions/fabricv4.json b/cmd/descriptions/fabricv4.json new file mode 100644 index 0000000..8944943 --- /dev/null +++ b/cmd/descriptions/fabricv4.json @@ -0,0 +1,33082 @@ +{ + "services": { + "cloud-events": { + "service_name": "cloud-events", + "service_description": "", + "methods": { + "GetCloudEvent": { + "short_description": "Get Cloud Event", + "long_description": "This API provides capability to retrieve a cloud event by uuid", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "cloudEventId", + "description": "Cloud Event UUID" + } + ] + }, + "GetCloudEventByAssetId": { + "short_description": "Get Cloud Events by Asset Id", + "long_description": "This API provides capability to retrieve cloud events of an asset id", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "asset", + "description": "asset" + }, + { + "name": "assetId", + "description": "asset UUID" + } + ] + }, + "GetCloudEventByAssetIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetCloudEventExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchCloudEvents": { + "short_description": "Search Cloud Events", + "long_description": "This API provides capability to search cloud events from a filtered query", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchCloudEventsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGetCloudEventByAssetIdRequest": { + "type_name": "ApiGetCloudEventByAssetIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "asset": { + "name": "asset", + "description": "" + }, + "assetId": { + "name": "assetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "fromDateTime": { + "name": "fromDateTime", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "toDateTime": { + "name": "toDateTime", + "description": "" + } + } + }, + "ApiGetCloudEventRequest": { + "type_name": "ApiGetCloudEventRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudEventId": { + "name": "cloudEventId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiSearchCloudEventsRequest": { + "type_name": "ApiSearchCloudEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudEventSearchRequest": { + "name": "cloudEventSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + } + } + }, + "cloud-routers": { + "service_name": "cloud-routers", + "service_description": "", + "methods": { + "CreateCloudRouter": { + "short_description": "Create Routers", + "long_description": "This API provides capability to create user's Cloud Routers", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateCloudRouterAction": { + "short_description": "Create Route Table Action", + "long_description": "This API provides capability to refresh route table and bgp session summary information", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Router UUID" + } + ] + }, + "CreateCloudRouterActionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateCloudRouterCommand": { + "short_description": "Initiate Command", + "long_description": "This API provides capability to initiate Command", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Router UUID" + } + ] + }, + "CreateCloudRouterCommandExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateCloudRouterExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteCloudRouterByUuid": { + "short_description": "Delete Routers", + "long_description": "This API provides capability to delete user's Cloud Routers", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Cloud Router UUID" + } + ] + }, + "DeleteCloudRouterByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteCloudRouterCommandByUuid": { + "short_description": "Delete Command", + "long_description": "This API provides capability to delete command based on command Id", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Router UUID" + }, + { + "name": "commandId", + "description": "Command UUID" + } + ] + }, + "DeleteCloudRouterCommandByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetAllCloudRouterCommands": { + "short_description": "Get Commands", + "long_description": "This API provides capability to fetch all commands", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Router UUID" + } + ] + }, + "GetAllCloudRouterCommandsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetCloudRouterActions": { + "short_description": "Get Route Table Actions", + "long_description": "This API provides capability to fetch action status", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Router UUID" + } + ] + }, + "GetCloudRouterActionsByUuid": { + "short_description": "Get Route Table Action by ID", + "long_description": "This API provides capability to fetch action status", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Router UUID" + }, + { + "name": "actionId", + "description": "Action UUID" + } + ] + }, + "GetCloudRouterActionsByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetCloudRouterActionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetCloudRouterByUuid": { + "short_description": "Get Routers", + "long_description": "This API provides capability to retrieve user's Cloud Routers", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Cloud Router UUID" + } + ] + }, + "GetCloudRouterByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetCloudRouterCommand": { + "short_description": "Get Command", + "long_description": "This API provides capability to fetch command using command Id", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Router UUID" + }, + { + "name": "commandId", + "description": "Command UUID" + } + ] + }, + "GetCloudRouterCommandExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetCloudRouterPackageByCode": { + "short_description": "Get Package Details", + "long_description": "This API provides capability to retrieve user's Cloud Routers Package Details", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerPackageCode", + "description": "assigned Cloud Router package identifier" + } + ] + }, + "GetCloudRouterPackageByCodeExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetCloudRouterPackages": { + "short_description": "List Packages", + "long_description": "This API provides capability to retrieve user's Cloud Routers Packages", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetCloudRouterPackagesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetGatewayAttachmentToCloudRouterByUuid": { + "short_description": "Get Gateway Attachment details to a Cloud Router", + "long_description": "Get details of a Specific Gateway Attachment to a Cloud Router.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "gatewayId", + "description": "Gateway UUID" + }, + { + "name": "routerId", + "description": "Cloud Router UUID" + } + ] + }, + "GetGatewayAttachmentToCloudRouterByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ListGatewayAttachmentsToCloudRouter": { + "short_description": "List Cloud Routers of a Gateway Attachment.", + "long_description": "Get all Cloud Routers attached on a Gateway.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "gatewayId", + "description": "Gateway UUID" + } + ] + }, + "ListGatewayAttachmentsToCloudRouterExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchCloudRouterCommands": { + "short_description": "Search Commands", + "long_description": "This API provides capability to search commands", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Router UUID" + } + ] + }, + "SearchCloudRouterCommandsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchCloudRouterRoutes": { + "short_description": "Search Route Table", + "long_description": "The API provides capability to get list of user's Fabric Cloud Router route table entries using search criteria, including optional filtering, pagination and sorting", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Router UUID" + } + ] + }, + "SearchCloudRouterRoutesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchCloudRouters": { + "short_description": "Search Routers", + "long_description": "The API provides capability to get list of user's Cloud Routers using search criteria, including optional filtering, pagination and sorting", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchCloudRoutersExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchConnectionAdvertisedRoutes": { + "short_description": "Search Advertised Routes", + "long_description": "The API provides capability to get list of user's advertised routes using search criteria, including optional filtering, pagination and sorting", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "SearchConnectionAdvertisedRoutesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchConnectionReceivedRoutes": { + "short_description": "Search Received Routes", + "long_description": "The API provides capability to get list of received routes using search criteria, including optional filtering, pagination and sorting", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "SearchConnectionReceivedRoutesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchRouterActions": { + "short_description": "Search Route Table Actions", + "long_description": "This API provides capability to refresh route table and bgp session summary information", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Router UUID" + } + ] + }, + "SearchRouterActionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateCloudRouterByUuid": { + "short_description": "Update Routers", + "long_description": "This API provides capability to update user's Cloud Routers", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Cloud Router UUID" + } + ] + }, + "UpdateCloudRouterByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateCloudRouterActionRequest": { + "type_name": "ApiCreateCloudRouterActionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterActionRequest": { + "name": "cloudRouterActionRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiCreateCloudRouterCommandRequest": { + "type_name": "ApiCreateCloudRouterCommandRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterCommandPostRequest": { + "name": "cloudRouterCommandPostRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiCreateCloudRouterRequest": { + "type_name": "ApiCreateCloudRouterRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterPostRequest": { + "name": "cloudRouterPostRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + } + } + }, + "ApiDeleteCloudRouterByUuidRequest": { + "type_name": "ApiDeleteCloudRouterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiDeleteCloudRouterCommandByUuidRequest": { + "type_name": "ApiDeleteCloudRouterCommandByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "commandId": { + "name": "commandId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiGetAllCloudRouterCommandsRequest": { + "type_name": "ApiGetAllCloudRouterCommandsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiGetCloudRouterActionsByUuidRequest": { + "type_name": "ApiGetCloudRouterActionsByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "actionId": { + "name": "actionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + }, + "state": { + "name": "state", + "description": "" + } + } + }, + "ApiGetCloudRouterActionsRequest": { + "type_name": "ApiGetCloudRouterActionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + }, + "state": { + "name": "state", + "description": "" + } + } + }, + "ApiGetCloudRouterByUuidRequest": { + "type_name": "ApiGetCloudRouterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiGetCloudRouterCommandRequest": { + "type_name": "ApiGetCloudRouterCommandRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "commandId": { + "name": "commandId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiGetCloudRouterPackageByCodeRequest": { + "type_name": "ApiGetCloudRouterPackageByCodeRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerPackageCode": { + "name": "routerPackageCode", + "description": "" + } + } + }, + "ApiGetCloudRouterPackagesRequest": { + "type_name": "ApiGetCloudRouterPackagesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + } + } + }, + "ApiGetGatewayAttachmentToCloudRouterByUuidRequest": { + "type_name": "ApiGetGatewayAttachmentToCloudRouterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "gatewayId": { + "name": "gatewayId", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiListGatewayAttachmentsToCloudRouterRequest": { + "type_name": "ApiListGatewayAttachmentsToCloudRouterRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "gatewayId": { + "name": "gatewayId", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + } + } + }, + "ApiSearchCloudRouterCommandsRequest": { + "type_name": "ApiSearchCloudRouterCommandsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterCommandSearchRequest": { + "name": "cloudRouterCommandSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiSearchCloudRouterRoutesRequest": { + "type_name": "ApiSearchCloudRouterRoutesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeTableEntrySearchRequest": { + "name": "routeTableEntrySearchRequest", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiSearchCloudRoutersRequest": { + "type_name": "ApiSearchCloudRoutersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterSearchRequest": { + "name": "cloudRouterSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiSearchConnectionAdvertisedRoutesRequest": { + "type_name": "ApiSearchConnectionAdvertisedRoutesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "connectionRouteSearchRequest": { + "name": "connectionRouteSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiSearchConnectionReceivedRoutesRequest": { + "type_name": "ApiSearchConnectionReceivedRoutesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "connectionRouteSearchRequest": { + "name": "connectionRouteSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiSearchRouterActionsRequest": { + "type_name": "ApiSearchRouterActionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterActionsSearchRequest": { + "name": "cloudRouterActionsSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiUpdateCloudRouterByUuidRequest": { + "type_name": "ApiUpdateCloudRouterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterChangeOperation": { + "name": "cloudRouterChangeOperation", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + } + } + }, + "connections": { + "service_name": "connections", + "service_description": "", + "methods": { + "CreateConnection": { + "short_description": "Create Connection", + "long_description": "This API provides capability to create user's virtual connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateConnectionAction": { + "short_description": "Connection Actions", + "long_description": "This API provides capability to accept/reject user's virtual connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "CreateConnectionActionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateConnectionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteConnectionByUuid": { + "short_description": "Delete by ID", + "long_description": "Delete Connection by ID", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection UUID" + } + ] + }, + "DeleteConnectionByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionByUuid": { + "short_description": "Get Connection by ID", + "long_description": "The API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID)", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "GetConnectionByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchConnections": { + "short_description": "Search connections", + "long_description": "The API provides capability to get list of user's virtual connections using search criteria, including optional filtering, pagination and sorting", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchConnectionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateConnectionByUuid": { + "short_description": "Update by ID", + "long_description": "Update Connection by ID", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "UpdateConnectionByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ValidateConnections": { + "short_description": "Validate Connection", + "long_description": "This API provides capability to validate by auth key", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "ValidateConnectionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateConnectionActionRequest": { + "type_name": "ApiCreateConnectionActionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionActionRequest": { + "name": "connectionActionRequest", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiCreateConnectionRequest": { + "type_name": "ApiCreateConnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionPostRequest": { + "name": "connectionPostRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + } + } + }, + "ApiDeleteConnectionByUuidRequest": { + "type_name": "ApiDeleteConnectionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetConnectionByUuidRequest": { + "type_name": "ApiGetConnectionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "direction": { + "name": "direction", + "description": "" + } + } + }, + "ApiSearchConnectionsRequest": { + "type_name": "ApiSearchConnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "searchRequest": { + "name": "searchRequest", + "description": "" + } + } + }, + "ApiUpdateConnectionByUuidRequest": { + "type_name": "ApiUpdateConnectionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionChangeOperation": { + "name": "connectionChangeOperation", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + } + } + }, + "ApiValidateConnectionsRequest": { + "type_name": "ApiValidateConnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "validateRequest": { + "name": "validateRequest", + "description": "" + } + } + } + } + }, + "health": { + "service_name": "health", + "service_description": "", + "methods": { + "GetStatus": { + "short_description": "Get service status", + "long_description": "GET All service health statys with an option query parameter to return all Equinix Fabric customer in which the customer has a presence.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetStatusExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGetStatusRequest": { + "type_name": "ApiGetStatusRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + } + } + }, + "marketplace-subscriptions": { + "service_name": "marketplace-subscriptions", + "service_description": "", + "methods": { + "GetSubscriptionById": { + "short_description": "Get Subscription", + "long_description": "The API provides capability to get subscription", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "subscriptionId", + "description": "Subscription UUID" + } + ] + }, + "GetSubscriptionByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGetSubscriptionByIdRequest": { + "type_name": "ApiGetSubscriptionByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "" + } + } + } + } + }, + "metrics": { + "service_name": "metrics", + "service_description": "", + "methods": { + "GetMetricByAssetId": { + "short_description": "Get Metrics by Asset Id", + "long_description": "This API provides capability to retrieve Metrics of an asset id", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "asset", + "description": "asset" + }, + { + "name": "assetId", + "description": "asset UUID" + } + ] + }, + "GetMetricByAssetIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchMetrics": { + "short_description": "Search Metrics", + "long_description": "This API provides capability to search metrics from a filtered query", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchMetricsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGetMetricByAssetIdRequest": { + "type_name": "ApiGetMetricByAssetIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "asset": { + "name": "asset", + "description": "" + }, + "assetId": { + "name": "assetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "fromDateTime": { + "name": "fromDateTime", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "name": { + "name": "name", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "toDateTime": { + "name": "toDateTime", + "description": "" + } + } + }, + "ApiSearchMetricsRequest": { + "type_name": "ApiSearchMetricsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "metricsSearchRequest": { + "name": "metricsSearchRequest", + "description": "" + } + } + } + } + }, + "metros": { + "service_name": "metros", + "service_description": "", + "methods": { + "GetMetroByCode": { + "short_description": "Get Metro by Code", + "long_description": "GET Metros retrieves all Equinix Fabric metros, as well as latency data between each metro location.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "metroCode", + "description": "Metro Code" + } + ] + }, + "GetMetroByCodeExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetMetros": { + "short_description": "Get all Metros", + "long_description": "GET All Subscriber Metros with an option query parameter to return all Equinix Fabric metros in which the customer has a presence, as well as latency data for each location.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetMetrosExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGetMetroByCodeRequest": { + "type_name": "ApiGetMetroByCodeRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "metroCode": { + "name": "metroCode", + "description": "" + } + } + }, + "ApiGetMetrosRequest": { + "type_name": "ApiGetMetrosRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "presence": { + "name": "presence", + "description": "" + } + } + } + } + }, + "networks": { + "service_name": "networks", + "service_description": "", + "methods": { + "CreateNetwork": { + "short_description": "Create Network", + "long_description": "This API provides capability to create user's Fabric Network", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateNetworkExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteNetworkByUuid": { + "short_description": "Delete Network By ID", + "long_description": "This API provides capability to delete user's Fabric Network", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "networkId", + "description": "Network UUID" + } + ] + }, + "DeleteNetworkByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionsByNetworkUuid": { + "short_description": "Get Connections", + "long_description": "The API provides capability to get list of user's Fabric Network connections", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "networkId", + "description": "Network UUID" + } + ] + }, + "GetConnectionsByNetworkUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetNetworkByUuid": { + "short_description": "Get Network By ID", + "long_description": "This API provides capability to retrieve user's Fabric Network", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "networkId", + "description": "Network UUID" + } + ] + }, + "GetNetworkByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetNetworkChangeByUuid": { + "short_description": "Get Change By ID", + "long_description": "This API provides capability to retrieve user's Fabric Network Change", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "networkId", + "description": "Network UUID" + }, + { + "name": "changeId", + "description": "Network Change UUID" + } + ] + }, + "GetNetworkChangeByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetNetworkChanges": { + "short_description": "Get Network Changes", + "long_description": "The API provides capability to get list of user's Fabric Network changes", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "networkId", + "description": "Network UUID" + } + ] + }, + "GetNetworkChangesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchNetworks": { + "short_description": "Search Network", + "long_description": "The API provides capability to get list of user's Fabric Network using search criteria, including optional filtering, pagination and sorting", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchNetworksExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateNetworkByUuid": { + "short_description": "Update Network By ID", + "long_description": "This API provides capability to update user's Fabric Network", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "networkId", + "description": "Network UUID" + } + ] + }, + "UpdateNetworkByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateNetworkRequest": { + "type_name": "ApiCreateNetworkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "networkPostRequest": { + "name": "networkPostRequest", + "description": "" + } + } + }, + "ApiDeleteNetworkByUuidRequest": { + "type_name": "ApiDeleteNetworkByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + }, + "ApiGetConnectionsByNetworkUuidRequest": { + "type_name": "ApiGetConnectionsByNetworkUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + }, + "ApiGetNetworkByUuidRequest": { + "type_name": "ApiGetNetworkByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + }, + "ApiGetNetworkChangeByUuidRequest": { + "type_name": "ApiGetNetworkChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + }, + "ApiGetNetworkChangesRequest": { + "type_name": "ApiGetNetworkChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + }, + "ApiSearchNetworksRequest": { + "type_name": "ApiSearchNetworksRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkSearchRequest": { + "name": "networkSearchRequest", + "description": "" + } + } + }, + "ApiUpdateNetworkByUuidRequest": { + "type_name": "ApiUpdateNetworkByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkChangeOperation": { + "name": "networkChangeOperation", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + } + } + }, + "port-packages": { + "service_name": "port-packages", + "service_description": "", + "methods": { + "GetPortPackages": { + "short_description": "Get All Port Packages", + "long_description": "Get All Port Packages returns details of all available port packages for the specified user credentials.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetPortPackagesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGetPortPackagesRequest": { + "type_name": "ApiGetPortPackagesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + } + } + }, + "ports": { + "service_name": "ports", + "service_description": "", + "methods": { + "AddToLag": { + "short_description": "Add to Lag", + "long_description": "Add Physical Ports to Virtual Port.\u003cfont color=\"red\"\u003e \u003csup color='red'\u003ePreview\u003c/sup\u003e\u003c/font\u003e", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "portId", + "description": "Port UUID" + } + ] + }, + "AddToLagExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreatePort": { + "short_description": "Create Port", + "long_description": "Creates Equinix Fabric™ Port.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreatePortExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeletePort": { + "short_description": "Delete a single port", + "long_description": "The API provides capability to delete a single port", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "portId", + "description": "Port UUID" + } + ] + }, + "DeletePortExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetPortByUuid": { + "short_description": "Get Port by uuid", + "long_description": "Get Port By uuid returns details of assigned and available Equinix Fabric port for the specified user credentials. The metro code attribute in the response shows the origin of the proposed connection.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "portId", + "description": "Port UUID" + } + ] + }, + "GetPortByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetPorts": { + "short_description": "Get All Ports", + "long_description": "Get All Ports returns details of all assigned and available ports for the specified user credentials. The metro attribute in the response shows the origin of the proposed connection.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetPortsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetVlans": { + "short_description": "Get Vlans", + "long_description": "The API provides capability to retrieve Vlans for a Port.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "portUuid", + "description": "Port UUID" + } + ] + }, + "GetVlansExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchPorts": { + "short_description": "Search ports", + "long_description": "The API provides capability to get list of user's virtual ports using search criteria, including optional filtering, pagination and sorting", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchPortsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdatePortByUuid": { + "short_description": "Update by UUID", + "long_description": "Update Port by UUID", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "portId", + "description": "Port UUID" + } + ] + }, + "UpdatePortByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiAddToLagRequest": { + "type_name": "ApiAddToLagRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bulkPhysicalPort": { + "name": "bulkPhysicalPort", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + } + } + }, + "ApiCreatePortRequest": { + "type_name": "ApiCreatePortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "portRequest": { + "name": "portRequest", + "description": "" + } + } + }, + "ApiDeletePortRequest": { + "type_name": "ApiDeletePortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + } + } + }, + "ApiGetPortByUuidRequest": { + "type_name": "ApiGetPortByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + } + } + }, + "ApiGetPortsRequest": { + "type_name": "ApiGetPortsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "name": { + "name": "name", + "description": "" + } + } + }, + "ApiGetVlansRequest": { + "type_name": "ApiGetVlansRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "portUuid": { + "name": "portUuid", + "description": "" + } + } + }, + "ApiSearchPortsRequest": { + "type_name": "ApiSearchPortsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "portV4SearchRequest": { + "name": "portV4SearchRequest", + "description": "" + } + } + }, + "ApiUpdatePortByUuidRequest": { + "type_name": "ApiUpdatePortByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "portChangeOperation": { + "name": "portChangeOperation", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + } + } + } + } + }, + "precision-time": { + "service_name": "precision-time", + "service_description": "", + "methods": { + "CreateTimeServices": { + "short_description": "Create Time Service", + "long_description": "The API provides capability to create Precision Time service", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateTimeServicesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteTimeServiceById": { + "short_description": "Delete by ID.", + "long_description": "The API provides capability to delete Precision Time Service by service id.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceId", + "description": "Service UUID" + } + ] + }, + "DeleteTimeServiceByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FulfillTimeServices": { + "short_description": "Configure Service.", + "long_description": "The API provides capability to Configure/Fulfill the Precision Time Service.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceId", + "description": "Service UUID" + } + ] + }, + "FulfillTimeServicesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetTimeServicesById": { + "short_description": "Get Service By ID.", + "long_description": "The API provides capability to get Precision Time Service details", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceId", + "description": "Service UUID" + } + ] + }, + "GetTimeServicesByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetTimeServicesConnectionsByServiceId": { + "short_description": "Get Connection Links", + "long_description": "The API provides capability to get prevision timing service's details", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceId", + "description": "Service UUID" + } + ] + }, + "GetTimeServicesConnectionsByServiceIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetTimeServicesPackageByCode": { + "short_description": "Get Package By Code", + "long_description": "The API provides capability to get timing service's package by code", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "packageCode", + "description": "Package Code" + } + ] + }, + "GetTimeServicesPackageByCodeExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetTimeServicesPackages": { + "short_description": "Get Packages", + "long_description": "The API provides capability to get timing service's packages", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetTimeServicesPackagesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchTimeServices": { + "short_description": "Search Time Services", + "long_description": "The API provides capability to get list of user's Time Services using search criteria, including optional filtering, pagination and sorting", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchTimeServicesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateTimeServicesById": { + "short_description": "Update By ID.", + "long_description": "The API provides capability to update Precision Time Service by service id.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceId", + "description": "Service UUID" + } + ] + }, + "UpdateTimeServicesByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateTimeServicesRequest": { + "type_name": "ApiCreateTimeServicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "precisionTimeServiceRequest": { + "name": "precisionTimeServiceRequest", + "description": "" + } + } + }, + "ApiDeleteTimeServiceByIdRequest": { + "type_name": "ApiDeleteTimeServiceByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceId": { + "name": "serviceId", + "description": "" + } + } + }, + "ApiFulfillTimeServicesRequest": { + "type_name": "ApiFulfillTimeServicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "precisionTimeServiceRequest": { + "name": "precisionTimeServiceRequest", + "description": "" + }, + "serviceId": { + "name": "serviceId", + "description": "" + } + } + }, + "ApiGetTimeServicesByIdRequest": { + "type_name": "ApiGetTimeServicesByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceId": { + "name": "serviceId", + "description": "" + } + } + }, + "ApiGetTimeServicesConnectionsByServiceIdRequest": { + "type_name": "ApiGetTimeServicesConnectionsByServiceIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceId": { + "name": "serviceId", + "description": "" + } + } + }, + "ApiGetTimeServicesPackageByCodeRequest": { + "type_name": "ApiGetTimeServicesPackageByCodeRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "packageCode": { + "name": "packageCode", + "description": "" + } + } + }, + "ApiGetTimeServicesPackagesRequest": { + "type_name": "ApiGetTimeServicesPackagesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiSearchTimeServicesRequest": { + "type_name": "ApiSearchTimeServicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "timeServicesSearchRequest": { + "name": "timeServicesSearchRequest", + "description": "" + } + } + }, + "ApiUpdateTimeServicesByIdRequest": { + "type_name": "ApiUpdateTimeServicesByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "precisionTimeChangeOperation": { + "name": "precisionTimeChangeOperation", + "description": "" + }, + "serviceId": { + "name": "serviceId", + "description": "" + } + } + } + } + }, + "prices": { + "service_name": "prices", + "service_description": "", + "methods": { + "SearchPrices": { + "short_description": "Get Prices", + "long_description": "Search prices by search criteria", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchPricesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiSearchPricesRequest": { + "type_name": "ApiSearchPricesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "filterBody": { + "name": "filterBody", + "description": "" + } + } + } + } + }, + "route-aggregation-rules": { + "service_name": "route-aggregation-rules", + "service_description": "", + "methods": { + "CreateRouteAggregationRule": { + "short_description": "Create RARule", + "long_description": "This API provides capability to create a Route Aggregation Rule", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + } + ] + }, + "CreateRouteAggregationRuleExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateRouteAggregationRulesInBulk": { + "short_description": "Bulk RARules", + "long_description": "This API provides capability to create bulk route aggregation rules", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + } + ] + }, + "CreateRouteAggregationRulesInBulkExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteRouteAggregationRuleByUuid": { + "short_description": "DeleteRARule", + "long_description": "This API provides capability to delete a Route aggregation Rule", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + }, + { + "name": "routeAggregationRuleId", + "description": "Route Aggregation Rules Id" + } + ] + }, + "DeleteRouteAggregationRuleByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteAggregationRuleByUuid": { + "short_description": "GetRARule By UUID", + "long_description": "This API provides capability to view a Route Aggregation Rule by UUID", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + }, + { + "name": "routeAggregationRuleId", + "description": "Route Aggregation Rules Id" + } + ] + }, + "GetRouteAggregationRuleByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteAggregationRuleChangeByUuid": { + "short_description": "Get Change By ID", + "long_description": "This API provides capability to retrieve a specific Route Aggregation Rule's Changes", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + }, + { + "name": "routeAggregationRuleId", + "description": "Route Aggregation Rules Id" + }, + { + "name": "changeId", + "description": "Route Aggregation Rule Change UUID" + } + ] + }, + "GetRouteAggregationRuleChangeByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteAggregationRuleChanges": { + "short_description": "Get All Changes", + "long_description": "This API provides capability to retrieve all of a Route Aggregation Rule's Changes", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + }, + { + "name": "routeAggregationRuleId", + "description": "Route Aggregation Rules Id" + } + ] + }, + "GetRouteAggregationRuleChangesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteAggregationRules": { + "short_description": "GetRARules", + "long_description": "This API provides capability to get all Route Aggregations Rules for Fabric", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + } + ] + }, + "GetRouteAggregationRulesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "PatchRouteAggregationRuleByUuid": { + "short_description": "PatchRARule", + "long_description": "This API provides capability to partially update a Route Aggregation Rule", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + }, + { + "name": "routeAggregationRuleId", + "description": "Route Aggregation Rules Id" + } + ] + }, + "PatchRouteAggregationRuleByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ReplaceRouteAggregationRuleByUuid": { + "short_description": "ReplaceRARule", + "long_description": "This API provides capability to replace a Route Aggregation Rule completely", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + }, + { + "name": "routeAggregationRuleId", + "description": "Route Aggregation Rules Id" + } + ] + }, + "ReplaceRouteAggregationRuleByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateRouteAggregationRuleRequest": { + "type_name": "ApiCreateRouteAggregationRuleRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRulesBase": { + "name": "routeAggregationRulesBase", + "description": "" + } + } + }, + "ApiCreateRouteAggregationRulesInBulkRequest": { + "type_name": "ApiCreateRouteAggregationRulesInBulkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRulesPostRequest": { + "name": "routeAggregationRulesPostRequest", + "description": "" + } + } + }, + "ApiDeleteRouteAggregationRuleByUuidRequest": { + "type_name": "ApiDeleteRouteAggregationRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + } + } + }, + "ApiGetRouteAggregationRuleByUuidRequest": { + "type_name": "ApiGetRouteAggregationRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + } + } + }, + "ApiGetRouteAggregationRuleChangeByUuidRequest": { + "type_name": "ApiGetRouteAggregationRuleChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + } + } + }, + "ApiGetRouteAggregationRuleChangesRequest": { + "type_name": "ApiGetRouteAggregationRuleChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + } + } + }, + "ApiGetRouteAggregationRulesRequest": { + "type_name": "ApiGetRouteAggregationRulesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiPatchRouteAggregationRuleByUuidRequest": { + "type_name": "ApiPatchRouteAggregationRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + }, + "routeAggregationRulesPatchRequestItem": { + "name": "routeAggregationRulesPatchRequestItem", + "description": "" + } + } + }, + "ApiReplaceRouteAggregationRuleByUuidRequest": { + "type_name": "ApiReplaceRouteAggregationRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + }, + "routeAggregationRulesBase": { + "name": "routeAggregationRulesBase", + "description": "" + } + } + } + } + }, + "route-aggregations": { + "service_name": "route-aggregations", + "service_description": "", + "methods": { + "AttachConnectionRouteAggregation": { + "short_description": "Attach Aggregation", + "long_description": "This API provides capability to attach a Route Aggregation to a Connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "AttachConnectionRouteAggregationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateRouteAggregation": { + "short_description": "Create Aggregations", + "long_description": "This API provides capability to create a Route Aggregation", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateRouteAggregationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteRouteAggregationByUuid": { + "short_description": "Delete Aggregation", + "long_description": "This API provides capability to delete a Route Aggregation", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + } + ] + }, + "DeleteRouteAggregationByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DetachConnectionRouteAggregation": { + "short_description": "Detach Aggregation", + "long_description": "This API provides capability to detach a Route Aggregation from a Connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "DetachConnectionRouteAggregationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionRouteAggregationByUuid": { + "short_description": "Get Aggregation", + "long_description": "This API provides capability to view a specific Route Aggregation attached to a Connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "GetConnectionRouteAggregationByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionRouteAggregations": { + "short_description": "Get All Aggregations", + "long_description": "This API provides capability to view all Route Aggregations attached to a Connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "GetConnectionRouteAggregationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteAggregationByUuid": { + "short_description": "Get Aggregation", + "long_description": "This API provides capability to view a Route Aggregation by UUID", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + } + ] + }, + "GetRouteAggregationByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteAggregationChangeByUuid": { + "short_description": "Get Change By ID", + "long_description": "This API provides capability to retrieve a specific Route Aggregation's Changes", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + }, + { + "name": "changeId", + "description": "Routing Protocol Change UUID" + } + ] + }, + "GetRouteAggregationChangeByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteAggregationChanges": { + "short_description": "Get All Changes", + "long_description": "This API provides capability to retrieve all of a Route Aggregation's Changes", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + } + ] + }, + "GetRouteAggregationChangesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteAggregationConnections": { + "short_description": "Get All Connections on Route Aggregation", + "long_description": "This API provides capability to view all Connections using the Route Aggregation", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + } + ] + }, + "GetRouteAggregationConnectionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "PatchRouteAggregationByUuid": { + "short_description": "Patch Aggregation", + "long_description": "This API provides capability to partially update a Route Aggregation", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeAggregationId", + "description": "Route Aggregations Id" + } + ] + }, + "PatchRouteAggregationByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchRouteAggregations": { + "short_description": "Search Aggregations", + "long_description": "This API provides capability to search Route Aggregations", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchRouteAggregationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiAttachConnectionRouteAggregationRequest": { + "type_name": "ApiAttachConnectionRouteAggregationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiCreateRouteAggregationRequest": { + "type_name": "ApiCreateRouteAggregationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationsBase": { + "name": "routeAggregationsBase", + "description": "" + } + } + }, + "ApiDeleteRouteAggregationByUuidRequest": { + "type_name": "ApiDeleteRouteAggregationByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiDetachConnectionRouteAggregationRequest": { + "type_name": "ApiDetachConnectionRouteAggregationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiGetConnectionRouteAggregationByUuidRequest": { + "type_name": "ApiGetConnectionRouteAggregationByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiGetConnectionRouteAggregationsRequest": { + "type_name": "ApiGetConnectionRouteAggregationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetRouteAggregationByUuidRequest": { + "type_name": "ApiGetRouteAggregationByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiGetRouteAggregationChangeByUuidRequest": { + "type_name": "ApiGetRouteAggregationChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiGetRouteAggregationChangesRequest": { + "type_name": "ApiGetRouteAggregationChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiGetRouteAggregationConnectionsRequest": { + "type_name": "ApiGetRouteAggregationConnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiPatchRouteAggregationByUuidRequest": { + "type_name": "ApiPatchRouteAggregationByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationsPatchRequestItem": { + "name": "routeAggregationsPatchRequestItem", + "description": "" + } + } + }, + "ApiSearchRouteAggregationsRequest": { + "type_name": "ApiSearchRouteAggregationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationsSearchBase": { + "name": "routeAggregationsSearchBase", + "description": "" + } + } + } + } + }, + "route-filter-rules": { + "service_name": "route-filter-rules", + "service_description": "", + "methods": { + "CreateRouteFilterRule": { + "short_description": "Create Route Filter Rule", + "long_description": "This API provides capability to create a Route Filter Rule", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + } + ] + }, + "CreateRouteFilterRuleExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateRouteFilterRulesInBulk": { + "short_description": "Bulk Create Route Filter Rules", + "long_description": "This API provides capability to create bulk route filter rules", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + } + ] + }, + "CreateRouteFilterRulesInBulkExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteRouteFilterRuleByUuid": { + "short_description": "Delete Route Filter Rule", + "long_description": "This API provides capability to delete a Route Filter Rule", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + }, + { + "name": "routeFilterRuleId", + "description": "Route Filter Rules Id" + } + ] + }, + "DeleteRouteFilterRuleByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteFilterRuleByUuid": { + "short_description": "Get Route Filter Rule By UUID", + "long_description": "This API provides capability to view a Route Filter Rule by UUID", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + }, + { + "name": "routeFilterRuleId", + "description": "Route Filter Rules Id" + } + ] + }, + "GetRouteFilterRuleByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteFilterRuleChangeByUuid": { + "short_description": "Get Change By ID", + "long_description": "This API provides capability to retrieve a specific Route Filter Rule's Changes", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + }, + { + "name": "routeFilterRuleId", + "description": "Route Filter Rules Id" + }, + { + "name": "changeId", + "description": "Route Filter Rule Change UUID" + } + ] + }, + "GetRouteFilterRuleChangeByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteFilterRuleChanges": { + "short_description": "Get All Changes", + "long_description": "This API provides capability to retrieve all of a Route Filter Rule's Changes", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + }, + { + "name": "routeFilterRuleId", + "description": "Route Filter Rules Id" + } + ] + }, + "GetRouteFilterRuleChangesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteFilterRules": { + "short_description": "Get Route Filter Rules", + "long_description": "This API provides capability to get all Route Filters Rules for Fabric", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + } + ] + }, + "GetRouteFilterRulesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "PatchRouteFilterRuleByUuid": { + "short_description": "Patch Route Filter Rule", + "long_description": "This API provides capability to partially update a Route Filter Rule", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + }, + { + "name": "routeFilterRuleId", + "description": "Route Filter Rules Id" + } + ] + }, + "PatchRouteFilterRuleByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ReplaceRouteFilterRuleByUuid": { + "short_description": "Replace Route Filter Rule", + "long_description": "This API provides capability to replace a Route Filter Rule completely", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + }, + { + "name": "routeFilterRuleId", + "description": "Route Filter Rules Id" + } + ] + }, + "ReplaceRouteFilterRuleByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateRouteFilterRuleRequest": { + "type_name": "ApiCreateRouteFilterRuleRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRulesBase": { + "name": "routeFilterRulesBase", + "description": "" + } + } + }, + "ApiCreateRouteFilterRulesInBulkRequest": { + "type_name": "ApiCreateRouteFilterRulesInBulkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRulesPostRequest": { + "name": "routeFilterRulesPostRequest", + "description": "" + } + } + }, + "ApiDeleteRouteFilterRuleByUuidRequest": { + "type_name": "ApiDeleteRouteFilterRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + } + } + }, + "ApiGetRouteFilterRuleByUuidRequest": { + "type_name": "ApiGetRouteFilterRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + } + } + }, + "ApiGetRouteFilterRuleChangeByUuidRequest": { + "type_name": "ApiGetRouteFilterRuleChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + } + } + }, + "ApiGetRouteFilterRuleChangesRequest": { + "type_name": "ApiGetRouteFilterRuleChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + } + } + }, + "ApiGetRouteFilterRulesRequest": { + "type_name": "ApiGetRouteFilterRulesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiPatchRouteFilterRuleByUuidRequest": { + "type_name": "ApiPatchRouteFilterRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + }, + "routeFilterRulesPatchRequestItem": { + "name": "routeFilterRulesPatchRequestItem", + "description": "" + } + } + }, + "ApiReplaceRouteFilterRuleByUuidRequest": { + "type_name": "ApiReplaceRouteFilterRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + }, + "routeFilterRulesBase": { + "name": "routeFilterRulesBase", + "description": "" + } + } + } + } + }, + "route-filters": { + "service_name": "route-filters", + "service_description": "", + "methods": { + "AttachConnectionRouteFilter": { + "short_description": "Attach Route Filter", + "long_description": "This API provides capability to attach a Route Filter to a Connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "AttachConnectionRouteFilterExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateRouteFilter": { + "short_description": "Create Route Filters", + "long_description": "This API provides capability to create a Route Filter", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateRouteFilterExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteRouteFilterByUuid": { + "short_description": "Delete Route Filter", + "long_description": "This API provides capability to delete a Route Filter", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + } + ] + }, + "DeleteRouteFilterByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DetachConnectionRouteFilter": { + "short_description": "Detach Route Filter", + "long_description": "This API provides capability to detach a Route Filter from a Connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "DetachConnectionRouteFilterExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionRouteFilterByUuid": { + "short_description": "Get Route Filter", + "long_description": "This API provides capability to view a specific Route Filter attached to a Connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "GetConnectionRouteFilterByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionRouteFilters": { + "short_description": "Get All Route Filters", + "long_description": "This API provides capability to view all Route Filters attached to a Connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "GetConnectionRouteFiltersExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteFilterByUuid": { + "short_description": "Get Route Filter By UUID", + "long_description": "This API provides capability to view a Route Filter by UUID", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + } + ] + }, + "GetRouteFilterByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteFilterChangeByUuid": { + "short_description": "Get Change By ID", + "long_description": "This API provides capability to retrieve a specific Route Filter's Changes", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + }, + { + "name": "changeId", + "description": "Routing Protocol Change UUID" + } + ] + }, + "GetRouteFilterChangeByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteFilterChanges": { + "short_description": "Get All Changes", + "long_description": "This API provides capability to retrieve all of a Route Filter's Changes", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + } + ] + }, + "GetRouteFilterChangesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetRouteFilterConnections": { + "short_description": "Get All Connections on Route Filter", + "long_description": "This API provides capability to view all Connections using the Route Filter", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + } + ] + }, + "GetRouteFilterConnectionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "PatchRouteFilterByUuid": { + "short_description": "Patch Route Filter", + "long_description": "This API provides capability to partially update a Route Filter", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routeFilterId", + "description": "Route Filters Id" + } + ] + }, + "PatchRouteFilterByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchRouteFilters": { + "short_description": "Search Route Filters", + "long_description": "This API provides capability to search Route Filters", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchRouteFiltersExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiAttachConnectionRouteFilterRequest": { + "type_name": "ApiAttachConnectionRouteFilterRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "connectionRouteFiltersBase": { + "name": "connectionRouteFiltersBase", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiCreateRouteFilterRequest": { + "type_name": "ApiCreateRouteFilterRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFiltersBase": { + "name": "routeFiltersBase", + "description": "" + } + } + }, + "ApiDeleteRouteFilterByUuidRequest": { + "type_name": "ApiDeleteRouteFilterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiDetachConnectionRouteFilterRequest": { + "type_name": "ApiDetachConnectionRouteFilterRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiGetConnectionRouteFilterByUuidRequest": { + "type_name": "ApiGetConnectionRouteFilterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiGetConnectionRouteFiltersRequest": { + "type_name": "ApiGetConnectionRouteFiltersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetRouteFilterByUuidRequest": { + "type_name": "ApiGetRouteFilterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiGetRouteFilterChangeByUuidRequest": { + "type_name": "ApiGetRouteFilterChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiGetRouteFilterChangesRequest": { + "type_name": "ApiGetRouteFilterChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiGetRouteFilterConnectionsRequest": { + "type_name": "ApiGetRouteFilterConnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiPatchRouteFilterByUuidRequest": { + "type_name": "ApiPatchRouteFilterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFiltersPatchRequestItem": { + "name": "routeFiltersPatchRequestItem", + "description": "" + } + } + }, + "ApiSearchRouteFiltersRequest": { + "type_name": "ApiSearchRouteFiltersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFiltersSearchBase": { + "name": "routeFiltersSearchBase", + "description": "" + } + } + } + } + }, + "routing-protocols": { + "service_name": "routing-protocols", + "service_description": "", + "methods": { + "CreateConnectionRoutingProtocol": { + "short_description": "Create Protocol", + "long_description": "This API provides capability to create Routing Protocol for connections", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "CreateConnectionRoutingProtocolExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateConnectionRoutingProtocolsInBulk": { + "short_description": "Bulk Create Protocol", + "long_description": "This API provides capability to create Routing Protocol for connections", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "CreateConnectionRoutingProtocolsInBulkExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteConnectionRoutingProtocolByUuid": { + "short_description": "Delete Protocol", + "long_description": "This API provides capability to delete Routing Protocols on virtual connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routingProtocolId", + "description": "Routing Protocol Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "DeleteConnectionRoutingProtocolByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionRoutingProtocolAllBgpActions": { + "short_description": "Get BGP Actions", + "long_description": "This API provides capability to get all BGP actions status", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routingProtocolId", + "description": "Routing Protocol Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "GetConnectionRoutingProtocolAllBgpActionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionRoutingProtocolByUuid": { + "short_description": "Get Protocol", + "long_description": "This API provides capability to accept/reject user's virtual connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routingProtocolId", + "description": "Routing Protocol Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "GetConnectionRoutingProtocolByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionRoutingProtocols": { + "short_description": "GetRoutingProtocols", + "long_description": "This API provides capability to get Routing Protocols for connections", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "GetConnectionRoutingProtocolsBgpActionByUuid": { + "short_description": "Get BGP Action", + "long_description": "This API provides capability to retrieve specific BGP action", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + }, + { + "name": "routingProtocolId", + "description": "Routing Protocol Id" + }, + { + "name": "actionId", + "description": "BGP Action UUID" + } + ] + }, + "GetConnectionRoutingProtocolsBgpActionByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionRoutingProtocolsChangeByUuid": { + "short_description": "Get Change By ID", + "long_description": "This API provides capability to retrieve specific Routing Protocol Change", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + }, + { + "name": "routingProtocolId", + "description": "Routing Protocol Id" + }, + { + "name": "changeId", + "description": "Routing Protocol Change UUID" + } + ] + }, + "GetConnectionRoutingProtocolsChangeByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionRoutingProtocolsChanges": { + "short_description": "Get Changes", + "long_description": "This API provides capability to retrieve user's Routing Protocol Changes", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection Id" + }, + { + "name": "routingProtocolId", + "description": "Routing Protocol Id" + } + ] + }, + "GetConnectionRoutingProtocolsChangesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetConnectionRoutingProtocolsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "PatchConnectionRoutingProtocolByUuid": { + "short_description": "Patch Protocol", + "long_description": "This API provides capability to partially update Routing Protocols on a virtual connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routingProtocolId", + "description": "Routing Protocol Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "PatchConnectionRoutingProtocolByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "PostConnectionRoutingProtocolBgpActionByUuid": { + "short_description": "Clear/Reset BGP", + "long_description": "This API provides capability to clear/reset Routing Protocols BGP session", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routingProtocolId", + "description": "Routing Protocol Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "PostConnectionRoutingProtocolBgpActionByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ReplaceConnectionRoutingProtocolByUuid": { + "short_description": "Replace Protocol", + "long_description": "This API provides capability to replace complete Routing Protocols on a virtual connection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routingProtocolId", + "description": "Routing Protocol Id" + }, + { + "name": "connectionId", + "description": "Connection Id" + } + ] + }, + "ReplaceConnectionRoutingProtocolByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ValidateRoutingProtocol": { + "short_description": "Validate Subnet", + "long_description": "This API provides capability to validate all subnets associated with any connection in the given FCR", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "routerId", + "description": "Cloud Router UUID" + } + ] + }, + "ValidateRoutingProtocolExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateConnectionRoutingProtocolRequest": { + "type_name": "ApiCreateConnectionRoutingProtocolRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolBase": { + "name": "routingProtocolBase", + "description": "" + } + } + }, + "ApiCreateConnectionRoutingProtocolsInBulkRequest": { + "type_name": "ApiCreateConnectionRoutingProtocolsInBulkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "connectionRoutingProtocolPostRequest": { + "name": "connectionRoutingProtocolPostRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiDeleteConnectionRoutingProtocolByUuidRequest": { + "type_name": "ApiDeleteConnectionRoutingProtocolByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolAllBgpActionsRequest": { + "type_name": "ApiGetConnectionRoutingProtocolAllBgpActionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolByUuidRequest": { + "type_name": "ApiGetConnectionRoutingProtocolByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolsBgpActionByUuidRequest": { + "type_name": "ApiGetConnectionRoutingProtocolsBgpActionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "actionId": { + "name": "actionId", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolsChangeByUuidRequest": { + "type_name": "ApiGetConnectionRoutingProtocolsChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolsChangesRequest": { + "type_name": "ApiGetConnectionRoutingProtocolsChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolsRequest": { + "type_name": "ApiGetConnectionRoutingProtocolsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + } + } + }, + "ApiPatchConnectionRoutingProtocolByUuidRequest": { + "type_name": "ApiPatchConnectionRoutingProtocolByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionChangeOperation": { + "name": "connectionChangeOperation", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiPostConnectionRoutingProtocolBgpActionByUuidRequest": { + "type_name": "ApiPostConnectionRoutingProtocolBgpActionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bGPActionRequest": { + "name": "bGPActionRequest", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiReplaceConnectionRoutingProtocolByUuidRequest": { + "type_name": "ApiReplaceConnectionRoutingProtocolByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolBase": { + "name": "routingProtocolBase", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiValidateRoutingProtocolRequest": { + "type_name": "ApiValidateRoutingProtocolRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + }, + "validateRequest": { + "name": "validateRequest", + "description": "" + } + } + } + } + }, + "service-profiles": { + "service_name": "service-profiles", + "service_description": "", + "methods": { + "CreateServiceProfile": { + "short_description": "Create Profile", + "long_description": "Create Service Profile creates Equinix Fabric™ Service Profile.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateServiceProfileExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteServiceProfileByUuid": { + "short_description": "Delete Profile", + "long_description": "delete Service Profile by UUID", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceProfileId", + "description": "Service Profile UUID" + } + ] + }, + "DeleteServiceProfileByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetServiceProfileByUuid": { + "short_description": "Get Profile", + "long_description": "Get service profile by UUID. View Point parameter if set to zSide will give seller's view of the profile otherwise buyer's view.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceProfileId", + "description": "Service Profile UUID" + } + ] + }, + "GetServiceProfileByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetServiceProfileMetrosByUuid": { + "short_description": "Get Profile Metros", + "long_description": "Get service profile metros by UUID.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceProfileId", + "description": "Service Profile UUID" + } + ] + }, + "GetServiceProfileMetrosByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetServiceProfiles": { + "short_description": "Get all Profiles", + "long_description": "The API request returns all Equinix Fabric Service Profiles in accordance with the view point requested.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetServiceProfilesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "PutServiceProfileByUuid": { + "short_description": "Replace Profile", + "long_description": "This API request replaces a service profile definition", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceProfileId", + "description": "Service Profile UUID" + } + ] + }, + "PutServiceProfileByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchServiceProfiles": { + "short_description": "Profile Search", + "long_description": "Search service profiles by search criteria", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchServiceProfilesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateServiceProfileByUuid": { + "short_description": "Update Profile", + "long_description": "Update Service Profile by UUID", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceProfileId", + "description": "Service Profile UUID" + } + ] + }, + "UpdateServiceProfileByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateServiceProfileRequest": { + "type_name": "ApiCreateServiceProfileRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceProfileRequest": { + "name": "serviceProfileRequest", + "description": "" + } + } + }, + "ApiDeleteServiceProfileByUuidRequest": { + "type_name": "ApiDeleteServiceProfileByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceProfileId": { + "name": "serviceProfileId", + "description": "" + } + } + }, + "ApiGetServiceProfileByUuidRequest": { + "type_name": "ApiGetServiceProfileByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceProfileId": { + "name": "serviceProfileId", + "description": "" + }, + "viewPoint": { + "name": "viewPoint", + "description": "" + } + } + }, + "ApiGetServiceProfileMetrosByUuidRequest": { + "type_name": "ApiGetServiceProfileMetrosByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "serviceProfileId": { + "name": "serviceProfileId", + "description": "" + } + } + }, + "ApiGetServiceProfilesRequest": { + "type_name": "ApiGetServiceProfilesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "viewPoint": { + "name": "viewPoint", + "description": "" + } + } + }, + "ApiPutServiceProfileByUuidRequest": { + "type_name": "ApiPutServiceProfileByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "ifMatch": { + "name": "ifMatch", + "description": "" + }, + "serviceProfileId": { + "name": "serviceProfileId", + "description": "" + }, + "serviceProfileRequest": { + "name": "serviceProfileRequest", + "description": "" + } + } + }, + "ApiSearchServiceProfilesRequest": { + "type_name": "ApiSearchServiceProfilesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceProfileSearchRequest": { + "name": "serviceProfileSearchRequest", + "description": "" + }, + "viewPoint": { + "name": "viewPoint", + "description": "" + } + } + }, + "ApiUpdateServiceProfileByUuidRequest": { + "type_name": "ApiUpdateServiceProfileByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "ifMatch": { + "name": "ifMatch", + "description": "" + }, + "jsonPatchOperation": { + "name": "jsonPatchOperation", + "description": "" + }, + "serviceProfileId": { + "name": "serviceProfileId", + "description": "" + } + } + } + } + }, + "service-tokens": { + "service_name": "service-tokens", + "service_description": "", + "methods": { + "CreateServiceToken": { + "short_description": "Create Service Token", + "long_description": "Create Service Tokens generates Equinix Fabric™ service tokens. These tokens authorize users to access protected resources and services.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateServiceTokenAction": { + "short_description": "ServiceToken Actions", + "long_description": "This API provides capability to accept/reject user's servicetokens", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceTokenId", + "description": "Service Token UUID" + } + ] + }, + "CreateServiceTokenActionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateServiceTokenExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteServiceTokenByUuid": { + "short_description": "Delete Token by uuid", + "long_description": "Delete Service Tokens removes an Equinix Fabric service token corresponding to the specified uuid which are in INACTIVE state.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceTokenId", + "description": "Service Token UUID" + } + ] + }, + "DeleteServiceTokenByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetServiceTokenByUuid": { + "short_description": "Get Token by uuid", + "long_description": "Get Specified Service Tokens uses the uuid of an Equinix Fabric service token to return details about the token's type, state, location, bandwidth, and other key properties.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceTokenId", + "description": "Service Token UUID" + } + ] + }, + "GetServiceTokenByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetServiceTokens": { + "short_description": "Get All Tokens", + "long_description": "Get All ServiceTokens creates a list of all Equinix Fabric service tokens associated with the subscriber's account.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetServiceTokensExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SearchServiceTokens": { + "short_description": "Search servicetokens", + "long_description": "The API provides capability to get list of user's servicetokens using search criteria, including optional filtering, pagination and sorting", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SearchServiceTokensExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateServiceTokenByUuid": { + "short_description": "Update Token By ID", + "long_description": "This API provides capability to update user's Service Token", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "serviceTokenId", + "description": "Service Token UUID" + } + ] + }, + "UpdateServiceTokenByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateServiceTokenActionRequest": { + "type_name": "ApiCreateServiceTokenActionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceTokenActionRequest": { + "name": "serviceTokenActionRequest", + "description": "" + }, + "serviceTokenId": { + "name": "serviceTokenId", + "description": "" + } + } + }, + "ApiCreateServiceTokenRequest": { + "type_name": "ApiCreateServiceTokenRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "serviceToken": { + "name": "serviceToken", + "description": "" + } + } + }, + "ApiDeleteServiceTokenByUuidRequest": { + "type_name": "ApiDeleteServiceTokenByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceTokenId": { + "name": "serviceTokenId", + "description": "" + } + } + }, + "ApiGetServiceTokenByUuidRequest": { + "type_name": "ApiGetServiceTokenByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceTokenId": { + "name": "serviceTokenId", + "description": "" + } + } + }, + "ApiGetServiceTokensRequest": { + "type_name": "ApiGetServiceTokensRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + } + } + }, + "ApiSearchServiceTokensRequest": { + "type_name": "ApiSearchServiceTokensRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "serviceTokenSearchRequest": { + "name": "serviceTokenSearchRequest", + "description": "" + } + } + }, + "ApiUpdateServiceTokenByUuidRequest": { + "type_name": "ApiUpdateServiceTokenByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "serviceTokenChangeOperation": { + "name": "serviceTokenChangeOperation", + "description": "" + }, + "serviceTokenId": { + "name": "serviceTokenId", + "description": "" + } + } + } + } + }, + "statistics": { + "service_name": "statistics", + "service_description": "", + "methods": { + "GetConnectionStatsByPortUuid": { + "short_description": "Get Stats by uuid **(DEPRECATED)**", + "long_description": "This API provides service-level metrics so that you can view access and gather key information required to manage service subscription sizing and capacity **(DEPRECATED)** Deprecated", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Connection UUID" + } + ] + }, + "GetConnectionStatsByPortUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "Deprecated" + }, + "GetPortStatsByPortUuid": { + "short_description": "Get Stats by uuid **(DEPRECATED)**", + "long_description": "This API provides service-level traffic metrics so that you can view access and gather key information required to manage service subscription sizing and capacity.**(DEPRECATED)** Deprecated", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "portId", + "description": "Port UUID" + } + ] + }, + "GetPortStatsByPortUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "Deprecated" + } + }, + "types": { + "ApiGetConnectionStatsByPortUuidRequest": { + "type_name": "ApiGetConnectionStatsByPortUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "endDateTime": { + "name": "endDateTime", + "description": "" + }, + "startDateTime": { + "name": "startDateTime", + "description": "" + }, + "viewPoint": { + "name": "viewPoint", + "description": "" + } + } + }, + "ApiGetPortStatsByPortUuidRequest": { + "type_name": "ApiGetPortStatsByPortUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "endDateTime": { + "name": "endDateTime", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + }, + "startDateTime": { + "name": "startDateTime", + "description": "" + } + } + } + } + }, + "stream-alert-rules": { + "service_name": "stream-alert-rules", + "service_description": "", + "methods": { + "CreateStreamAlertRules": { + "short_description": "Create Stream Alert Rules", + "long_description": "This API provides capability to create user's Stream Alert Rules", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + } + ] + }, + "CreateStreamAlertRulesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteStreamAlertRuleByUuid": { + "short_description": "Update Stream Alert Rules", + "long_description": "This API provides capability to delete a user's stream alert rule", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + }, + { + "name": "alertRuleId", + "description": "alert rule UUID" + } + ] + }, + "DeleteStreamAlertRuleByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetStreamAlertRuleByUuid": { + "short_description": "Get Stream Alert Rules", + "long_description": "This API provides capability to get user's stream alert rules", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + }, + { + "name": "alertRuleId", + "description": "alert rule UUID" + } + ] + }, + "GetStreamAlertRuleByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetStreamAlertRules": { + "short_description": "Get Stream Alert Rules", + "long_description": "This API provides capability to retrieve stream alert rules", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + } + ] + }, + "GetStreamAlertRulesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateStreamAlertRuleByUuid": { + "short_description": "Update Stream Alert Rules", + "long_description": "This API provides capability to update a user's stream alert rule", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + }, + { + "name": "alertRuleId", + "description": "alert rule UUID" + } + ] + }, + "UpdateStreamAlertRuleByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateStreamAlertRulesRequest": { + "type_name": "ApiCreateStreamAlertRulesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "alertRulePostRequest": { + "name": "alertRulePostRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiDeleteStreamAlertRuleByUuidRequest": { + "type_name": "ApiDeleteStreamAlertRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "alertRuleId": { + "name": "alertRuleId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiGetStreamAlertRuleByUuidRequest": { + "type_name": "ApiGetStreamAlertRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "alertRuleId": { + "name": "alertRuleId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiGetStreamAlertRulesRequest": { + "type_name": "ApiGetStreamAlertRulesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiUpdateStreamAlertRuleByUuidRequest": { + "type_name": "ApiUpdateStreamAlertRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "alertRuleId": { + "name": "alertRuleId", + "description": "" + }, + "alertRulePutRequest": { + "name": "alertRulePutRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + } + } + }, + "stream-subscriptions": { + "service_name": "stream-subscriptions", + "service_description": "", + "methods": { + "CreateStreamSubscriptions": { + "short_description": "Create Subscription", + "long_description": "This API provides capability to create user's Stream Subscriptions", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + } + ] + }, + "CreateStreamSubscriptionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteStreamSubscriptionByUuid": { + "short_description": "Delete Subscription", + "long_description": "This API provides capability to delete user's Stream Subscriptions", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + }, + { + "name": "subscriptionId", + "description": "Stream Subscription UUID" + } + ] + }, + "DeleteStreamSubscriptionByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetStreamSubscriptionByUuid": { + "short_description": "Get Subscription", + "long_description": "This API provides capability to delete user's get Stream Subscriptions", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + }, + { + "name": "subscriptionId", + "description": "Stream Subscription UUID" + } + ] + }, + "GetStreamSubscriptionByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetStreamSubscriptions": { + "short_description": "Get Subscriptions", + "long_description": "This API provides capability to retrieve stream subscriptions", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + } + ] + }, + "GetStreamSubscriptionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateStreamSubscriptionByUuid": { + "short_description": "Update Subscription", + "long_description": "This API provides capability to update user's Stream Subscriptions", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + }, + { + "name": "subscriptionId", + "description": "Stream Subscription UUID" + } + ] + }, + "UpdateStreamSubscriptionByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateStreamSubscriptionsRequest": { + "type_name": "ApiCreateStreamSubscriptionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + }, + "streamSubscriptionPostRequest": { + "name": "streamSubscriptionPostRequest", + "description": "" + } + } + }, + "ApiDeleteStreamSubscriptionByUuidRequest": { + "type_name": "ApiDeleteStreamSubscriptionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "" + } + } + }, + "ApiGetStreamSubscriptionByUuidRequest": { + "type_name": "ApiGetStreamSubscriptionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "" + } + } + }, + "ApiGetStreamSubscriptionsRequest": { + "type_name": "ApiGetStreamSubscriptionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiUpdateStreamSubscriptionByUuidRequest": { + "type_name": "ApiUpdateStreamSubscriptionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + }, + "streamSubscriptionPutRequest": { + "name": "streamSubscriptionPutRequest", + "description": "" + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "" + } + } + } + } + }, + "streams": { + "service_name": "streams", + "service_description": "", + "methods": { + "CreateStreams": { + "short_description": "Create Stream", + "long_description": "This API provides capability to create user's stream", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateStreamsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteStreamAssetByUuid": { + "short_description": "Detach Asset", + "long_description": "This API provides capability to detach an asset from a stream", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "assetId", + "description": "asset UUID" + }, + { + "name": "asset", + "description": "asset" + }, + { + "name": "streamId", + "description": "Stream UUID" + } + ] + }, + "DeleteStreamAssetByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteStreamByUuid": { + "short_description": "Delete Stream", + "long_description": "This API provides capability to delete user's stream", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + } + ] + }, + "DeleteStreamByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetStreamAssetByUuid": { + "short_description": "Get Asset", + "long_description": "This API provides capability to get user's assets attached to a stream", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "assetId", + "description": "asset UUID" + }, + { + "name": "asset", + "description": "asset" + }, + { + "name": "streamId", + "description": "Stream UUID" + } + ] + }, + "GetStreamAssetByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetStreamByUuid": { + "short_description": "Get Stream", + "long_description": "This API provides capability to get user's stream", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + } + ] + }, + "GetStreamByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetStreams": { + "short_description": "Get Streams", + "long_description": "This API provides capability to retrieve streams", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetStreamsAssets": { + "short_description": "Get Assets", + "long_description": "This API provides capability to retrieve stream assets", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetStreamsAssetsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetStreamsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateStreamAssetByUuid": { + "short_description": "Attach Asset", + "long_description": "This API provides capability to attach an asset to a stream", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "assetId", + "description": "asset UUID" + }, + { + "name": "asset", + "description": "asset" + }, + { + "name": "streamId", + "description": "Stream UUID" + } + ] + }, + "UpdateStreamAssetByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateStreamByUuid": { + "short_description": "Update Stream", + "long_description": "This API provides capability to update user's stream", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "streamId", + "description": "Stream UUID" + } + ] + }, + "UpdateStreamByUuidExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateStreamsRequest": { + "type_name": "ApiCreateStreamsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamPostRequest": { + "name": "streamPostRequest", + "description": "" + } + } + }, + "ApiDeleteStreamAssetByUuidRequest": { + "type_name": "ApiDeleteStreamAssetByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "asset": { + "name": "asset", + "description": "" + }, + "assetId": { + "name": "assetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiDeleteStreamByUuidRequest": { + "type_name": "ApiDeleteStreamByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiGetStreamAssetByUuidRequest": { + "type_name": "ApiGetStreamAssetByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "asset": { + "name": "asset", + "description": "" + }, + "assetId": { + "name": "assetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiGetStreamByUuidRequest": { + "type_name": "ApiGetStreamByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiGetStreamsAssetsRequest": { + "type_name": "ApiGetStreamsAssetsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "streamAssetSearchRequest": { + "name": "streamAssetSearchRequest", + "description": "" + } + } + }, + "ApiGetStreamsRequest": { + "type_name": "ApiGetStreamsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + } + } + }, + "ApiUpdateStreamAssetByUuidRequest": { + "type_name": "ApiUpdateStreamAssetByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "asset": { + "name": "asset", + "description": "" + }, + "assetId": { + "name": "assetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamAssetPutRequest": { + "name": "streamAssetPutRequest", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiUpdateStreamByUuidRequest": { + "type_name": "ApiUpdateStreamByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + }, + "streamPutRequest": { + "name": "streamPutRequest", + "description": "" + } + } + } + } + } + }, + "types": { + "APIClient": { + "type_name": "APIClient", + "description": "APIClient manages communication with the Equinix Fabric API v4 API v4.25\nIn most cases there should be only one, shared, APIClient.", + "fields": { + "CloudEventsApi": { + "name": "CloudEventsApi", + "description": "" + }, + "CloudRoutersApi": { + "name": "CloudRoutersApi", + "description": "" + }, + "ConnectionsApi": { + "name": "ConnectionsApi", + "description": "" + }, + "HealthApi": { + "name": "HealthApi", + "description": "" + }, + "MarketplaceSubscriptionsApi": { + "name": "MarketplaceSubscriptionsApi", + "description": "" + }, + "MetricsApi": { + "name": "MetricsApi", + "description": "" + }, + "MetrosApi": { + "name": "MetrosApi", + "description": "" + }, + "NetworksApi": { + "name": "NetworksApi", + "description": "" + }, + "PortPackagesApi": { + "name": "PortPackagesApi", + "description": "" + }, + "PortsApi": { + "name": "PortsApi", + "description": "" + }, + "PrecisionTimeApi": { + "name": "PrecisionTimeApi", + "description": "" + }, + "PricesApi": { + "name": "PricesApi", + "description": "" + }, + "RouteAggregationRulesApi": { + "name": "RouteAggregationRulesApi", + "description": "" + }, + "RouteAggregationsApi": { + "name": "RouteAggregationsApi", + "description": "" + }, + "RouteFilterRulesApi": { + "name": "RouteFilterRulesApi", + "description": "" + }, + "RouteFiltersApi": { + "name": "RouteFiltersApi", + "description": "" + }, + "RoutingProtocolsApi": { + "name": "RoutingProtocolsApi", + "description": "" + }, + "ServiceProfilesApi": { + "name": "ServiceProfilesApi", + "description": "" + }, + "ServiceTokensApi": { + "name": "ServiceTokensApi", + "description": "" + }, + "StatisticsApi": { + "name": "StatisticsApi", + "description": "" + }, + "StreamAlertRulesApi": { + "name": "StreamAlertRulesApi", + "description": "" + }, + "StreamSubscriptionsApi": { + "name": "StreamSubscriptionsApi", + "description": "" + }, + "StreamsApi": { + "name": "StreamsApi", + "description": "" + }, + "cfg": { + "name": "cfg", + "description": "" + }, + "common": { + "name": "common", + "description": "Reuse a single struct instead of allocating one for each service on the heap." + } + } + }, + "APIKey": { + "type_name": "APIKey", + "description": "APIKey provides API key based authentication to a request passed via context using ContextAPIKey", + "fields": { + "Key": { + "name": "Key", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "" + } + } + }, + "APIResponse": { + "type_name": "APIResponse", + "description": "APIResponse stores the API response returned by the server.", + "fields": { + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "Method": { + "name": "Method", + "description": "Method is the HTTP method used for the request. This value is always\navailable, even if the embedded *http.Response is nil.", + "json_tag": "method" + }, + "Operation": { + "name": "Operation", + "description": "Operation is the name of the OpenAPI operation.", + "json_tag": "operation" + }, + "Payload": { + "name": "Payload", + "description": "Payload holds the contents of the response body (which may be nil or empty).\nThis is provided here as the raw response.Body() reader will have already\nbeen drained.", + "json_tag": "-" + }, + "RequestURL": { + "name": "RequestURL", + "description": "RequestURL is the request URL. This value is always available, even if the\nembedded *http.Response is nil.", + "json_tag": "url" + } + } + }, + "AWSDirectConnect": { + "type_name": "AWSDirectConnect", + "description": "AWSDirectConnect Direct Connect helps to identify the direct connect to use or creates new one.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "AWSDirectConnectResponse": { + "type_name": "AWSDirectConnectResponse", + "description": "AWSDirectConnectResponse struct for AWSDirectConnectResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "AWSPermission": { + "type_name": "AWSPermission", + "description": "AWSPermission Provides the AWS permission configuration for the orchestrator. This permission is used to manage the AWS resources and their access control.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Region": { + "name": "Region", + "description": "", + "json_tag": "region" + }, + "RoleArn": { + "name": "RoleArn", + "description": "", + "json_tag": "roleArn" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "AWSProvider": { + "type_name": "AWSProvider", + "description": "AWSProvider The Orchestrator AWS Providers schema defines the structure for the orchestrator aws provider configuration.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Resources": { + "name": "Resources", + "description": "", + "json_tag": "resources" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "AWSProviderResource": { + "type_name": "AWSProviderResource", + "description": "AWSProviderResource - struct for AWSProviderResource", + "fields": { + "AWSDirectConnect": { + "name": "AWSDirectConnect", + "description": "" + }, + "AWSPermission": { + "name": "AWSPermission", + "description": "" + }, + "AWSVirtualPrivateGateway": { + "name": "AWSVirtualPrivateGateway", + "description": "" + } + } + }, + "AWSProviderResourceResponse": { + "type_name": "AWSProviderResourceResponse", + "description": "AWSProviderResourceResponse - struct for AWSProviderResourceResponse", + "fields": { + "AWSDirectConnectResponse": { + "name": "AWSDirectConnectResponse", + "description": "" + }, + "AWSPermission": { + "name": "AWSPermission", + "description": "" + }, + "AWSVirtualPrivateGatewayResponse": { + "name": "AWSVirtualPrivateGatewayResponse", + "description": "" + } + } + }, + "AWSProviderResponse": { + "type_name": "AWSProviderResponse", + "description": "AWSProviderResponse struct for AWSProviderResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Resources": { + "name": "Resources", + "description": "", + "json_tag": "resources" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "AWSVirtualPrivateGateway": { + "type_name": "AWSVirtualPrivateGateway", + "description": "AWSVirtualPrivateGateway The VirtualPrivateGateway schema defines the structure for the virtual private gateway configuration. It includes details about the gateway type, required flag, VPC and subnet IDs, and deployment properties.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Required": { + "name": "Required", + "description": "", + "json_tag": "required" + }, + "SubnetId": { + "name": "SubnetId", + "description": "", + "json_tag": "subnetId" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "VpcId": { + "name": "VpcId", + "description": "", + "json_tag": "vpcId" + } + } + }, + "AWSVirtualPrivateGatewayResponse": { + "type_name": "AWSVirtualPrivateGatewayResponse", + "description": "AWSVirtualPrivateGatewayResponse struct for AWSVirtualPrivateGatewayResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Id": { + "name": "Id", + "description": "Virtual private gateway id.", + "json_tag": "id" + }, + "Required": { + "name": "Required", + "description": "", + "json_tag": "required" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "SubnetId": { + "name": "SubnetId", + "description": "", + "json_tag": "subnetId" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "VpcId": { + "name": "VpcId", + "description": "", + "json_tag": "vpcId" + } + } + }, + "AccessPoint": { + "type_name": "AccessPoint", + "description": "AccessPoint Access point object", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AuthenticationKey": { + "name": "AuthenticationKey", + "description": "Access point authentication key", + "json_tag": "authenticationKey" + }, + "Interconnection": { + "name": "Interconnection", + "description": "", + "json_tag": "interconnection" + }, + "Interface": { + "name": "Interface", + "description": "", + "json_tag": "interface" + }, + "LinkProtocol": { + "name": "LinkProtocol", + "description": "", + "json_tag": "linkProtocol" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Network": { + "name": "Network", + "description": "", + "json_tag": "network" + }, + "PeeringType": { + "name": "PeeringType", + "description": "", + "json_tag": "peeringType" + }, + "Port": { + "name": "Port", + "description": "", + "json_tag": "port" + }, + "Profile": { + "name": "Profile", + "description": "", + "json_tag": "profile" + }, + "ProviderConnectionId": { + "name": "ProviderConnectionId", + "description": "Provider assigned Connection Id", + "json_tag": "providerConnectionId" + }, + "Role": { + "name": "Role", + "description": "", + "json_tag": "role" + }, + "Router": { + "name": "Router", + "description": "", + "json_tag": "router" + }, + "SellerRegion": { + "name": "SellerRegion", + "description": "Access point seller region", + "json_tag": "sellerRegion" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "VirtualDevice": { + "name": "VirtualDevice", + "description": "", + "json_tag": "virtualDevice" + }, + "VirtualNetwork": { + "name": "VirtualNetwork", + "description": "", + "json_tag": "virtualNetwork" + }, + "VpicInterface": { + "name": "VpicInterface", + "description": "", + "json_tag": "vpic_interface" + } + } + }, + "AccessPointSelector": { + "type_name": "AccessPointSelector", + "description": "AccessPointSelector List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "HideAssetInfo": { + "name": "HideAssetInfo", + "description": "Deprecated", + "json_tag": "hideAssetInfo" + }, + "Interface": { + "name": "Interface", + "description": "", + "json_tag": "interface" + }, + "LinkProtocol": { + "name": "LinkProtocol", + "description": "", + "json_tag": "linkProtocol" + }, + "Network": { + "name": "Network", + "description": "", + "json_tag": "network" + }, + "Port": { + "name": "Port", + "description": "", + "json_tag": "port" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "VirtualDevice": { + "name": "VirtualDevice", + "description": "", + "json_tag": "virtualDevice" + } + } + }, + "ActionRequest": { + "type_name": "ActionRequest", + "description": "ActionRequest - struct for ActionRequest", + "fields": { + "AWSPermission": { + "name": "AWSPermission", + "description": "" + }, + "GCPPermission": { + "name": "GCPPermission", + "description": "" + } + } + }, + "AddOperation": { + "type_name": "AddOperation", + "description": "AddOperation Add Sub-Resource to the existing model", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "A JSON Pointer path.", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "value to add", + "json_tag": "value" + } + } + }, + "AlertRulePostRequest": { + "type_name": "AlertRulePostRequest", + "description": "AlertRulePostRequest Create Stream Alert Rules", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Customer-provided stream description", + "json_tag": "description" + }, + "DetectionMethod": { + "name": "DetectionMethod", + "description": "", + "json_tag": "detectionMethod" + }, + "Enabled": { + "name": "Enabled", + "description": "Stream alert rule enabled status", + "json_tag": "enabled" + }, + "MetricSelector": { + "name": "MetricSelector", + "description": "", + "json_tag": "metricSelector" + }, + "Name": { + "name": "Name", + "description": "Customer-provided stream name", + "json_tag": "name" + }, + "ResourceSelector": { + "name": "ResourceSelector", + "description": "", + "json_tag": "resourceSelector" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "AlertRulePutRequest": { + "type_name": "AlertRulePutRequest", + "description": "AlertRulePutRequest Create Stream Alert Rules", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Customer-provided stream description", + "json_tag": "description" + }, + "DetectionMethod": { + "name": "DetectionMethod", + "description": "", + "json_tag": "detectionMethod" + }, + "Enabled": { + "name": "Enabled", + "description": "Stream alert rule enabled status", + "json_tag": "enabled" + }, + "MetricSelector": { + "name": "MetricSelector", + "description": "", + "json_tag": "metricSelector" + }, + "Name": { + "name": "Name", + "description": "Customer-provided stream name", + "json_tag": "name" + }, + "ResourceSelector": { + "name": "ResourceSelector", + "description": "", + "json_tag": "resourceSelector" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "AllPhysicalPortsResponse": { + "type_name": "AllPhysicalPortsResponse", + "description": "AllPhysicalPortsResponse GET All Physical Ports", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "GET All Physical Ports", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "AllPortPackagesResponse": { + "type_name": "AllPortPackagesResponse", + "description": "AllPortPackagesResponse Port Packages response", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of Port Packages", + "json_tag": "data" + } + } + }, + "AllPortsResponse": { + "type_name": "AllPortsResponse", + "description": "AllPortsResponse GET All User Port Across Fabric Metros", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "GET All User Port Across Fabric Metros", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "ApiAddToLagRequest": { + "type_name": "ApiAddToLagRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bulkPhysicalPort": { + "name": "bulkPhysicalPort", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + } + } + }, + "ApiAttachConnectionRouteAggregationRequest": { + "type_name": "ApiAttachConnectionRouteAggregationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiAttachConnectionRouteFilterRequest": { + "type_name": "ApiAttachConnectionRouteFilterRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "connectionRouteFiltersBase": { + "name": "connectionRouteFiltersBase", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiConfig": { + "type_name": "ApiConfig", + "description": "ApiConfig Configuration for API based Integration for Service Profile", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AllowOverSubscription": { + "name": "AllowOverSubscription", + "description": "Setting showing that oversubscription support is available (true) or not (false). The default is false. Oversubscription is the sale of more than the available network bandwidth. This practice is common and legitimate. After all, many customers use less bandwidth than they've purchased. And network users don't consume bandwidth all at the same time. The leftover bandwidth can be sold to other customers. When demand surges, operational and engineering resources can be shifted to accommodate the load.", + "json_tag": "allowOverSubscription" + }, + "ApiAvailable": { + "name": "ApiAvailable", + "description": "Setting indicating whether the API is available (true) or not (false).", + "json_tag": "apiAvailable" + }, + "BandwidthFromApi": { + "name": "BandwidthFromApi", + "description": "", + "json_tag": "bandwidthFromApi" + }, + "EquinixManagedPort": { + "name": "EquinixManagedPort", + "description": "Setting indicating that the port is managed by Equinix (true) or not (false).", + "json_tag": "equinixManagedPort" + }, + "EquinixManagedVlan": { + "name": "EquinixManagedVlan", + "description": "Setting indicating that the VLAN is managed by Equinix (true) or not (false).", + "json_tag": "equinixManagedVlan" + }, + "IntegrationId": { + "name": "IntegrationId", + "description": "", + "json_tag": "integrationId" + }, + "OverSubscriptionLimit": { + "name": "OverSubscriptionLimit", + "description": "A cap on oversubscription.", + "json_tag": "overSubscriptionLimit" + } + } + }, + "ApiCreateCloudRouterActionRequest": { + "type_name": "ApiCreateCloudRouterActionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterActionRequest": { + "name": "cloudRouterActionRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiCreateCloudRouterCommandRequest": { + "type_name": "ApiCreateCloudRouterCommandRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterCommandPostRequest": { + "name": "cloudRouterCommandPostRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiCreateCloudRouterRequest": { + "type_name": "ApiCreateCloudRouterRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterPostRequest": { + "name": "cloudRouterPostRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + } + } + }, + "ApiCreateConnectionActionRequest": { + "type_name": "ApiCreateConnectionActionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionActionRequest": { + "name": "connectionActionRequest", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiCreateConnectionRequest": { + "type_name": "ApiCreateConnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionPostRequest": { + "name": "connectionPostRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + } + } + }, + "ApiCreateConnectionRoutingProtocolRequest": { + "type_name": "ApiCreateConnectionRoutingProtocolRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolBase": { + "name": "routingProtocolBase", + "description": "" + } + } + }, + "ApiCreateConnectionRoutingProtocolsInBulkRequest": { + "type_name": "ApiCreateConnectionRoutingProtocolsInBulkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "connectionRoutingProtocolPostRequest": { + "name": "connectionRoutingProtocolPostRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiCreateNetworkRequest": { + "type_name": "ApiCreateNetworkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "networkPostRequest": { + "name": "networkPostRequest", + "description": "" + } + } + }, + "ApiCreatePortRequest": { + "type_name": "ApiCreatePortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "portRequest": { + "name": "portRequest", + "description": "" + } + } + }, + "ApiCreateRouteAggregationRequest": { + "type_name": "ApiCreateRouteAggregationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationsBase": { + "name": "routeAggregationsBase", + "description": "" + } + } + }, + "ApiCreateRouteAggregationRuleRequest": { + "type_name": "ApiCreateRouteAggregationRuleRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRulesBase": { + "name": "routeAggregationRulesBase", + "description": "" + } + } + }, + "ApiCreateRouteAggregationRulesInBulkRequest": { + "type_name": "ApiCreateRouteAggregationRulesInBulkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRulesPostRequest": { + "name": "routeAggregationRulesPostRequest", + "description": "" + } + } + }, + "ApiCreateRouteFilterRequest": { + "type_name": "ApiCreateRouteFilterRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFiltersBase": { + "name": "routeFiltersBase", + "description": "" + } + } + }, + "ApiCreateRouteFilterRuleRequest": { + "type_name": "ApiCreateRouteFilterRuleRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRulesBase": { + "name": "routeFilterRulesBase", + "description": "" + } + } + }, + "ApiCreateRouteFilterRulesInBulkRequest": { + "type_name": "ApiCreateRouteFilterRulesInBulkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRulesPostRequest": { + "name": "routeFilterRulesPostRequest", + "description": "" + } + } + }, + "ApiCreateServiceProfileRequest": { + "type_name": "ApiCreateServiceProfileRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceProfileRequest": { + "name": "serviceProfileRequest", + "description": "" + } + } + }, + "ApiCreateServiceTokenActionRequest": { + "type_name": "ApiCreateServiceTokenActionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceTokenActionRequest": { + "name": "serviceTokenActionRequest", + "description": "" + }, + "serviceTokenId": { + "name": "serviceTokenId", + "description": "" + } + } + }, + "ApiCreateServiceTokenRequest": { + "type_name": "ApiCreateServiceTokenRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "serviceToken": { + "name": "serviceToken", + "description": "" + } + } + }, + "ApiCreateStreamAlertRulesRequest": { + "type_name": "ApiCreateStreamAlertRulesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "alertRulePostRequest": { + "name": "alertRulePostRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiCreateStreamSubscriptionsRequest": { + "type_name": "ApiCreateStreamSubscriptionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + }, + "streamSubscriptionPostRequest": { + "name": "streamSubscriptionPostRequest", + "description": "" + } + } + }, + "ApiCreateStreamsRequest": { + "type_name": "ApiCreateStreamsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamPostRequest": { + "name": "streamPostRequest", + "description": "" + } + } + }, + "ApiCreateTimeServicesRequest": { + "type_name": "ApiCreateTimeServicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "precisionTimeServiceRequest": { + "name": "precisionTimeServiceRequest", + "description": "" + } + } + }, + "ApiDeleteCloudRouterByUuidRequest": { + "type_name": "ApiDeleteCloudRouterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiDeleteCloudRouterCommandByUuidRequest": { + "type_name": "ApiDeleteCloudRouterCommandByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "commandId": { + "name": "commandId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiDeleteConnectionByUuidRequest": { + "type_name": "ApiDeleteConnectionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiDeleteConnectionRoutingProtocolByUuidRequest": { + "type_name": "ApiDeleteConnectionRoutingProtocolByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiDeleteNetworkByUuidRequest": { + "type_name": "ApiDeleteNetworkByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + }, + "ApiDeletePortRequest": { + "type_name": "ApiDeletePortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + } + } + }, + "ApiDeleteRouteAggregationByUuidRequest": { + "type_name": "ApiDeleteRouteAggregationByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiDeleteRouteAggregationRuleByUuidRequest": { + "type_name": "ApiDeleteRouteAggregationRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + } + } + }, + "ApiDeleteRouteFilterByUuidRequest": { + "type_name": "ApiDeleteRouteFilterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiDeleteRouteFilterRuleByUuidRequest": { + "type_name": "ApiDeleteRouteFilterRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + } + } + }, + "ApiDeleteServiceProfileByUuidRequest": { + "type_name": "ApiDeleteServiceProfileByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceProfileId": { + "name": "serviceProfileId", + "description": "" + } + } + }, + "ApiDeleteServiceTokenByUuidRequest": { + "type_name": "ApiDeleteServiceTokenByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceTokenId": { + "name": "serviceTokenId", + "description": "" + } + } + }, + "ApiDeleteStreamAlertRuleByUuidRequest": { + "type_name": "ApiDeleteStreamAlertRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "alertRuleId": { + "name": "alertRuleId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiDeleteStreamAssetByUuidRequest": { + "type_name": "ApiDeleteStreamAssetByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "asset": { + "name": "asset", + "description": "" + }, + "assetId": { + "name": "assetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiDeleteStreamByUuidRequest": { + "type_name": "ApiDeleteStreamByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiDeleteStreamSubscriptionByUuidRequest": { + "type_name": "ApiDeleteStreamSubscriptionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "" + } + } + }, + "ApiDeleteTimeServiceByIdRequest": { + "type_name": "ApiDeleteTimeServiceByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceId": { + "name": "serviceId", + "description": "" + } + } + }, + "ApiDetachConnectionRouteAggregationRequest": { + "type_name": "ApiDetachConnectionRouteAggregationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiDetachConnectionRouteFilterRequest": { + "type_name": "ApiDetachConnectionRouteFilterRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiFulfillTimeServicesRequest": { + "type_name": "ApiFulfillTimeServicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "precisionTimeServiceRequest": { + "name": "precisionTimeServiceRequest", + "description": "" + }, + "serviceId": { + "name": "serviceId", + "description": "" + } + } + }, + "ApiGetAllCloudRouterCommandsRequest": { + "type_name": "ApiGetAllCloudRouterCommandsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiGetCloudEventByAssetIdRequest": { + "type_name": "ApiGetCloudEventByAssetIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "asset": { + "name": "asset", + "description": "" + }, + "assetId": { + "name": "assetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "fromDateTime": { + "name": "fromDateTime", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "toDateTime": { + "name": "toDateTime", + "description": "" + } + } + }, + "ApiGetCloudEventRequest": { + "type_name": "ApiGetCloudEventRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudEventId": { + "name": "cloudEventId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetCloudRouterActionsByUuidRequest": { + "type_name": "ApiGetCloudRouterActionsByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "actionId": { + "name": "actionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + }, + "state": { + "name": "state", + "description": "" + } + } + }, + "ApiGetCloudRouterActionsRequest": { + "type_name": "ApiGetCloudRouterActionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + }, + "state": { + "name": "state", + "description": "" + } + } + }, + "ApiGetCloudRouterByUuidRequest": { + "type_name": "ApiGetCloudRouterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiGetCloudRouterCommandRequest": { + "type_name": "ApiGetCloudRouterCommandRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "commandId": { + "name": "commandId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiGetCloudRouterPackageByCodeRequest": { + "type_name": "ApiGetCloudRouterPackageByCodeRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerPackageCode": { + "name": "routerPackageCode", + "description": "" + } + } + }, + "ApiGetCloudRouterPackagesRequest": { + "type_name": "ApiGetCloudRouterPackagesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + } + } + }, + "ApiGetConnectionByUuidRequest": { + "type_name": "ApiGetConnectionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "direction": { + "name": "direction", + "description": "" + } + } + }, + "ApiGetConnectionRouteAggregationByUuidRequest": { + "type_name": "ApiGetConnectionRouteAggregationByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiGetConnectionRouteAggregationsRequest": { + "type_name": "ApiGetConnectionRouteAggregationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetConnectionRouteFilterByUuidRequest": { + "type_name": "ApiGetConnectionRouteFilterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiGetConnectionRouteFiltersRequest": { + "type_name": "ApiGetConnectionRouteFiltersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolAllBgpActionsRequest": { + "type_name": "ApiGetConnectionRoutingProtocolAllBgpActionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolByUuidRequest": { + "type_name": "ApiGetConnectionRoutingProtocolByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolsBgpActionByUuidRequest": { + "type_name": "ApiGetConnectionRoutingProtocolsBgpActionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "actionId": { + "name": "actionId", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolsChangeByUuidRequest": { + "type_name": "ApiGetConnectionRoutingProtocolsChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolsChangesRequest": { + "type_name": "ApiGetConnectionRoutingProtocolsChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiGetConnectionRoutingProtocolsRequest": { + "type_name": "ApiGetConnectionRoutingProtocolsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + } + } + }, + "ApiGetConnectionStatsByPortUuidRequest": { + "type_name": "ApiGetConnectionStatsByPortUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "endDateTime": { + "name": "endDateTime", + "description": "" + }, + "startDateTime": { + "name": "startDateTime", + "description": "" + }, + "viewPoint": { + "name": "viewPoint", + "description": "" + } + } + }, + "ApiGetConnectionsByNetworkUuidRequest": { + "type_name": "ApiGetConnectionsByNetworkUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + }, + "ApiGetGatewayAttachmentToCloudRouterByUuidRequest": { + "type_name": "ApiGetGatewayAttachmentToCloudRouterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "gatewayId": { + "name": "gatewayId", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiGetMetricByAssetIdRequest": { + "type_name": "ApiGetMetricByAssetIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "asset": { + "name": "asset", + "description": "" + }, + "assetId": { + "name": "assetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "fromDateTime": { + "name": "fromDateTime", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "name": { + "name": "name", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "toDateTime": { + "name": "toDateTime", + "description": "" + } + } + }, + "ApiGetMetroByCodeRequest": { + "type_name": "ApiGetMetroByCodeRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "metroCode": { + "name": "metroCode", + "description": "" + } + } + }, + "ApiGetMetrosRequest": { + "type_name": "ApiGetMetrosRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "presence": { + "name": "presence", + "description": "" + } + } + }, + "ApiGetNetworkByUuidRequest": { + "type_name": "ApiGetNetworkByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + }, + "ApiGetNetworkChangeByUuidRequest": { + "type_name": "ApiGetNetworkChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + }, + "ApiGetNetworkChangesRequest": { + "type_name": "ApiGetNetworkChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + }, + "ApiGetPortByUuidRequest": { + "type_name": "ApiGetPortByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + } + } + }, + "ApiGetPortPackagesRequest": { + "type_name": "ApiGetPortPackagesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetPortStatsByPortUuidRequest": { + "type_name": "ApiGetPortStatsByPortUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "endDateTime": { + "name": "endDateTime", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + }, + "startDateTime": { + "name": "startDateTime", + "description": "" + } + } + }, + "ApiGetPortsRequest": { + "type_name": "ApiGetPortsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "name": { + "name": "name", + "description": "" + } + } + }, + "ApiGetRouteAggregationByUuidRequest": { + "type_name": "ApiGetRouteAggregationByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiGetRouteAggregationChangeByUuidRequest": { + "type_name": "ApiGetRouteAggregationChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiGetRouteAggregationChangesRequest": { + "type_name": "ApiGetRouteAggregationChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiGetRouteAggregationConnectionsRequest": { + "type_name": "ApiGetRouteAggregationConnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiGetRouteAggregationRuleByUuidRequest": { + "type_name": "ApiGetRouteAggregationRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + } + } + }, + "ApiGetRouteAggregationRuleChangeByUuidRequest": { + "type_name": "ApiGetRouteAggregationRuleChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + } + } + }, + "ApiGetRouteAggregationRuleChangesRequest": { + "type_name": "ApiGetRouteAggregationRuleChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + } + } + }, + "ApiGetRouteAggregationRulesRequest": { + "type_name": "ApiGetRouteAggregationRulesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + } + } + }, + "ApiGetRouteFilterByUuidRequest": { + "type_name": "ApiGetRouteFilterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiGetRouteFilterChangeByUuidRequest": { + "type_name": "ApiGetRouteFilterChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiGetRouteFilterChangesRequest": { + "type_name": "ApiGetRouteFilterChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiGetRouteFilterConnectionsRequest": { + "type_name": "ApiGetRouteFilterConnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiGetRouteFilterRuleByUuidRequest": { + "type_name": "ApiGetRouteFilterRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + } + } + }, + "ApiGetRouteFilterRuleChangeByUuidRequest": { + "type_name": "ApiGetRouteFilterRuleChangeByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "changeId": { + "name": "changeId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + } + } + }, + "ApiGetRouteFilterRuleChangesRequest": { + "type_name": "ApiGetRouteFilterRuleChangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + } + } + }, + "ApiGetRouteFilterRulesRequest": { + "type_name": "ApiGetRouteFilterRulesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + } + } + }, + "ApiGetServiceProfileByUuidRequest": { + "type_name": "ApiGetServiceProfileByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceProfileId": { + "name": "serviceProfileId", + "description": "" + }, + "viewPoint": { + "name": "viewPoint", + "description": "" + } + } + }, + "ApiGetServiceProfileMetrosByUuidRequest": { + "type_name": "ApiGetServiceProfileMetrosByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "serviceProfileId": { + "name": "serviceProfileId", + "description": "" + } + } + }, + "ApiGetServiceProfilesRequest": { + "type_name": "ApiGetServiceProfilesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "viewPoint": { + "name": "viewPoint", + "description": "" + } + } + }, + "ApiGetServiceTokenByUuidRequest": { + "type_name": "ApiGetServiceTokenByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceTokenId": { + "name": "serviceTokenId", + "description": "" + } + } + }, + "ApiGetServiceTokensRequest": { + "type_name": "ApiGetServiceTokensRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + } + } + }, + "ApiGetStatusRequest": { + "type_name": "ApiGetStatusRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetStreamAlertRuleByUuidRequest": { + "type_name": "ApiGetStreamAlertRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "alertRuleId": { + "name": "alertRuleId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiGetStreamAlertRulesRequest": { + "type_name": "ApiGetStreamAlertRulesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiGetStreamAssetByUuidRequest": { + "type_name": "ApiGetStreamAssetByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "asset": { + "name": "asset", + "description": "" + }, + "assetId": { + "name": "assetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiGetStreamByUuidRequest": { + "type_name": "ApiGetStreamByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiGetStreamSubscriptionByUuidRequest": { + "type_name": "ApiGetStreamSubscriptionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "" + } + } + }, + "ApiGetStreamSubscriptionsRequest": { + "type_name": "ApiGetStreamSubscriptionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiGetStreamsAssetsRequest": { + "type_name": "ApiGetStreamsAssetsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "streamAssetSearchRequest": { + "name": "streamAssetSearchRequest", + "description": "" + } + } + }, + "ApiGetStreamsRequest": { + "type_name": "ApiGetStreamsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + } + } + }, + "ApiGetSubscriptionByIdRequest": { + "type_name": "ApiGetSubscriptionByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "" + } + } + }, + "ApiGetTimeServicesByIdRequest": { + "type_name": "ApiGetTimeServicesByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceId": { + "name": "serviceId", + "description": "" + } + } + }, + "ApiGetTimeServicesConnectionsByServiceIdRequest": { + "type_name": "ApiGetTimeServicesConnectionsByServiceIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceId": { + "name": "serviceId", + "description": "" + } + } + }, + "ApiGetTimeServicesPackageByCodeRequest": { + "type_name": "ApiGetTimeServicesPackageByCodeRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "packageCode": { + "name": "packageCode", + "description": "" + } + } + }, + "ApiGetTimeServicesPackagesRequest": { + "type_name": "ApiGetTimeServicesPackagesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetVlansRequest": { + "type_name": "ApiGetVlansRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "portUuid": { + "name": "portUuid", + "description": "" + } + } + }, + "ApiListGatewayAttachmentsToCloudRouterRequest": { + "type_name": "ApiListGatewayAttachmentsToCloudRouterRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "gatewayId": { + "name": "gatewayId", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + } + } + }, + "ApiPatchConnectionRoutingProtocolByUuidRequest": { + "type_name": "ApiPatchConnectionRoutingProtocolByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionChangeOperation": { + "name": "connectionChangeOperation", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiPatchRouteAggregationByUuidRequest": { + "type_name": "ApiPatchRouteAggregationByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationsPatchRequestItem": { + "name": "routeAggregationsPatchRequestItem", + "description": "" + } + } + }, + "ApiPatchRouteAggregationRuleByUuidRequest": { + "type_name": "ApiPatchRouteAggregationRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + }, + "routeAggregationRulesPatchRequestItem": { + "name": "routeAggregationRulesPatchRequestItem", + "description": "" + } + } + }, + "ApiPatchRouteFilterByUuidRequest": { + "type_name": "ApiPatchRouteFilterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFiltersPatchRequestItem": { + "name": "routeFiltersPatchRequestItem", + "description": "" + } + } + }, + "ApiPatchRouteFilterRuleByUuidRequest": { + "type_name": "ApiPatchRouteFilterRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + }, + "routeFilterRulesPatchRequestItem": { + "name": "routeFilterRulesPatchRequestItem", + "description": "" + } + } + }, + "ApiPostConnectionRoutingProtocolBgpActionByUuidRequest": { + "type_name": "ApiPostConnectionRoutingProtocolBgpActionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bGPActionRequest": { + "name": "bGPActionRequest", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiPutServiceProfileByUuidRequest": { + "type_name": "ApiPutServiceProfileByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "ifMatch": { + "name": "ifMatch", + "description": "" + }, + "serviceProfileId": { + "name": "serviceProfileId", + "description": "" + }, + "serviceProfileRequest": { + "name": "serviceProfileRequest", + "description": "" + } + } + }, + "ApiReplaceConnectionRoutingProtocolByUuidRequest": { + "type_name": "ApiReplaceConnectionRoutingProtocolByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routingProtocolBase": { + "name": "routingProtocolBase", + "description": "" + }, + "routingProtocolId": { + "name": "routingProtocolId", + "description": "" + } + } + }, + "ApiReplaceRouteAggregationRuleByUuidRequest": { + "type_name": "ApiReplaceRouteAggregationRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationId": { + "name": "routeAggregationId", + "description": "" + }, + "routeAggregationRuleId": { + "name": "routeAggregationRuleId", + "description": "" + }, + "routeAggregationRulesBase": { + "name": "routeAggregationRulesBase", + "description": "" + } + } + }, + "ApiReplaceRouteFilterRuleByUuidRequest": { + "type_name": "ApiReplaceRouteFilterRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFilterId": { + "name": "routeFilterId", + "description": "" + }, + "routeFilterRuleId": { + "name": "routeFilterRuleId", + "description": "" + }, + "routeFilterRulesBase": { + "name": "routeFilterRulesBase", + "description": "" + } + } + }, + "ApiSearchCloudEventsRequest": { + "type_name": "ApiSearchCloudEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudEventSearchRequest": { + "name": "cloudEventSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiSearchCloudRouterCommandsRequest": { + "type_name": "ApiSearchCloudRouterCommandsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterCommandSearchRequest": { + "name": "cloudRouterCommandSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiSearchCloudRouterRoutesRequest": { + "type_name": "ApiSearchCloudRouterRoutesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeTableEntrySearchRequest": { + "name": "routeTableEntrySearchRequest", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiSearchCloudRoutersRequest": { + "type_name": "ApiSearchCloudRoutersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterSearchRequest": { + "name": "cloudRouterSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiSearchConnectionAdvertisedRoutesRequest": { + "type_name": "ApiSearchConnectionAdvertisedRoutesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "connectionRouteSearchRequest": { + "name": "connectionRouteSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiSearchConnectionReceivedRoutesRequest": { + "type_name": "ApiSearchConnectionReceivedRoutesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "connectionRouteSearchRequest": { + "name": "connectionRouteSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiSearchConnectionsRequest": { + "type_name": "ApiSearchConnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "searchRequest": { + "name": "searchRequest", + "description": "" + } + } + }, + "ApiSearchMetricsRequest": { + "type_name": "ApiSearchMetricsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "metricsSearchRequest": { + "name": "metricsSearchRequest", + "description": "" + } + } + }, + "ApiSearchNetworksRequest": { + "type_name": "ApiSearchNetworksRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkSearchRequest": { + "name": "networkSearchRequest", + "description": "" + } + } + }, + "ApiSearchPortsRequest": { + "type_name": "ApiSearchPortsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "portV4SearchRequest": { + "name": "portV4SearchRequest", + "description": "" + } + } + }, + "ApiSearchPricesRequest": { + "type_name": "ApiSearchPricesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "filterBody": { + "name": "filterBody", + "description": "" + } + } + }, + "ApiSearchRouteAggregationsRequest": { + "type_name": "ApiSearchRouteAggregationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeAggregationsSearchBase": { + "name": "routeAggregationsSearchBase", + "description": "" + } + } + }, + "ApiSearchRouteFiltersRequest": { + "type_name": "ApiSearchRouteFiltersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routeFiltersSearchBase": { + "name": "routeFiltersSearchBase", + "description": "" + } + } + }, + "ApiSearchRouterActionsRequest": { + "type_name": "ApiSearchRouterActionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterActionsSearchRequest": { + "name": "cloudRouterActionsSearchRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiSearchServiceProfilesRequest": { + "type_name": "ApiSearchServiceProfilesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "serviceProfileSearchRequest": { + "name": "serviceProfileSearchRequest", + "description": "" + }, + "viewPoint": { + "name": "viewPoint", + "description": "" + } + } + }, + "ApiSearchServiceTokensRequest": { + "type_name": "ApiSearchServiceTokensRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "limit": { + "name": "limit", + "description": "" + }, + "offset": { + "name": "offset", + "description": "" + }, + "serviceTokenSearchRequest": { + "name": "serviceTokenSearchRequest", + "description": "" + } + } + }, + "ApiSearchTimeServicesRequest": { + "type_name": "ApiSearchTimeServicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "timeServicesSearchRequest": { + "name": "timeServicesSearchRequest", + "description": "" + } + } + }, + "ApiServices": { + "type_name": "ApiServices", + "description": "ApiServices Available services details", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ChangedDateTime": { + "name": "ChangedDateTime", + "description": "service status change date", + "json_tag": "changedDateTime" + }, + "Route": { + "name": "Route", + "description": "service routes", + "json_tag": "route" + }, + "Status": { + "name": "Status", + "description": "service status", + "json_tag": "status" + } + } + }, + "ApiUpdateCloudRouterByUuidRequest": { + "type_name": "ApiUpdateCloudRouterByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cloudRouterChangeOperation": { + "name": "cloudRouterChangeOperation", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + } + } + }, + "ApiUpdateConnectionByUuidRequest": { + "type_name": "ApiUpdateConnectionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionChangeOperation": { + "name": "connectionChangeOperation", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + } + } + }, + "ApiUpdateNetworkByUuidRequest": { + "type_name": "ApiUpdateNetworkByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "networkChangeOperation": { + "name": "networkChangeOperation", + "description": "" + }, + "networkId": { + "name": "networkId", + "description": "" + } + } + }, + "ApiUpdatePortByUuidRequest": { + "type_name": "ApiUpdatePortByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "portChangeOperation": { + "name": "portChangeOperation", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + } + } + }, + "ApiUpdateServiceProfileByUuidRequest": { + "type_name": "ApiUpdateServiceProfileByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "ifMatch": { + "name": "ifMatch", + "description": "" + }, + "jsonPatchOperation": { + "name": "jsonPatchOperation", + "description": "" + }, + "serviceProfileId": { + "name": "serviceProfileId", + "description": "" + } + } + }, + "ApiUpdateServiceTokenByUuidRequest": { + "type_name": "ApiUpdateServiceTokenByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "dryRun": { + "name": "dryRun", + "description": "" + }, + "serviceTokenChangeOperation": { + "name": "serviceTokenChangeOperation", + "description": "" + }, + "serviceTokenId": { + "name": "serviceTokenId", + "description": "" + } + } + }, + "ApiUpdateStreamAlertRuleByUuidRequest": { + "type_name": "ApiUpdateStreamAlertRuleByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "alertRuleId": { + "name": "alertRuleId", + "description": "" + }, + "alertRulePutRequest": { + "name": "alertRulePutRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiUpdateStreamAssetByUuidRequest": { + "type_name": "ApiUpdateStreamAssetByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "asset": { + "name": "asset", + "description": "" + }, + "assetId": { + "name": "assetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamAssetPutRequest": { + "name": "streamAssetPutRequest", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + } + } + }, + "ApiUpdateStreamByUuidRequest": { + "type_name": "ApiUpdateStreamByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + }, + "streamPutRequest": { + "name": "streamPutRequest", + "description": "" + } + } + }, + "ApiUpdateStreamSubscriptionByUuidRequest": { + "type_name": "ApiUpdateStreamSubscriptionByUuidRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "streamId": { + "name": "streamId", + "description": "" + }, + "streamSubscriptionPutRequest": { + "name": "streamSubscriptionPutRequest", + "description": "" + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "" + } + } + }, + "ApiUpdateTimeServicesByIdRequest": { + "type_name": "ApiUpdateTimeServicesByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "precisionTimeChangeOperation": { + "name": "precisionTimeChangeOperation", + "description": "" + }, + "serviceId": { + "name": "serviceId", + "description": "" + } + } + }, + "ApiValidateConnectionsRequest": { + "type_name": "ApiValidateConnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "validateRequest": { + "name": "validateRequest", + "description": "" + } + } + }, + "ApiValidateRoutingProtocolRequest": { + "type_name": "ApiValidateRoutingProtocolRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "routerId": { + "name": "routerId", + "description": "" + }, + "validateRequest": { + "name": "validateRequest", + "description": "" + } + } + }, + "AuthContext": { + "type_name": "AuthContext", + "description": "AuthContext struct for AuthContext", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Authid": { + "name": "Authid", + "description": "", + "json_tag": "authid" + }, + "Authtype": { + "name": "Authtype", + "description": "", + "json_tag": "authtype" + }, + "Email": { + "name": "Email", + "description": "Cloud Event email", + "json_tag": "email" + }, + "Name": { + "name": "Name", + "description": "Cloud Event username", + "json_tag": "name" + } + } + }, + "AuthenticationKey": { + "type_name": "AuthenticationKey", + "description": "AuthenticationKey Authentication Key Support and Customization", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Label": { + "name": "Label", + "description": "", + "json_tag": "label" + }, + "Required": { + "name": "Required", + "description": "", + "json_tag": "required" + } + } + }, + "BGPActionData": { + "type_name": "BGPActionData", + "description": "BGPActionData struct for BGPActionData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Changelog": { + "name": "Changelog", + "description": "", + "json_tag": "changelog" + }, + "Description": { + "name": "Description", + "description": "BGP action description", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Routing Protocol URI", + "json_tag": "href" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Routing protocol identifier", + "json_tag": "uuid" + } + } + }, + "BGPActionRequest": { + "type_name": "BGPActionRequest", + "description": "BGPActionRequest BGP action request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "BGPActionsBulkData": { + "type_name": "BGPActionsBulkData", + "description": "BGPActionsBulkData List of BGP Actions", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "BGPConnectionIpv4": { + "type_name": "BGPConnectionIpv4", + "description": "BGPConnectionIpv4 struct for BGPConnectionIpv4", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerPeerIp": { + "name": "CustomerPeerIp", + "description": "Customer side peering ip", + "json_tag": "customerPeerIp" + }, + "Enabled": { + "name": "Enabled", + "description": "Admin status for the BGP session", + "json_tag": "enabled" + }, + "EquinixPeerIp": { + "name": "EquinixPeerIp", + "description": "Equinix side peering ip", + "json_tag": "equinixPeerIp" + }, + "InboundMED": { + "name": "InboundMED", + "description": "Inbound Multi Exit Discriminator attribute", + "json_tag": "inboundMED" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "OutboundASPrependCount": { + "name": "OutboundASPrependCount", + "description": "AS path prepend count", + "json_tag": "outboundASPrependCount" + }, + "OutboundMED": { + "name": "OutboundMED", + "description": "Outbound Multi Exit Discriminator attribute", + "json_tag": "outboundMED" + }, + "RoutesMax": { + "name": "RoutesMax", + "description": "Maximum learnt prefixes limit", + "json_tag": "routesMax" + } + } + }, + "BGPConnectionIpv6": { + "type_name": "BGPConnectionIpv6", + "description": "BGPConnectionIpv6 struct for BGPConnectionIpv6", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerPeerIp": { + "name": "CustomerPeerIp", + "description": "Customer side peering ip", + "json_tag": "customerPeerIp" + }, + "Enabled": { + "name": "Enabled", + "description": "Admin status for the BGP session", + "json_tag": "enabled" + }, + "EquinixPeerIp": { + "name": "EquinixPeerIp", + "description": "Equinix side peering ip", + "json_tag": "equinixPeerIp" + }, + "InboundMED": { + "name": "InboundMED", + "description": "Inbound Multi Exit Discriminator attribute", + "json_tag": "inboundMED" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "OutboundASPrependCount": { + "name": "OutboundASPrependCount", + "description": "AS path prepend count", + "json_tag": "outboundASPrependCount" + }, + "OutboundMED": { + "name": "OutboundMED", + "description": "Outbound Multi Exit Discriminator attribute", + "json_tag": "outboundMED" + }, + "RoutesMax": { + "name": "RoutesMax", + "description": "Maximum learnt prefixes limit", + "json_tag": "routesMax" + } + } + }, + "BGPConnectionOperation": { + "type_name": "BGPConnectionOperation", + "description": "BGPConnectionOperation BGP IPv4 or IPv6 Connection State operational data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "OpStatusChangedAt": { + "name": "OpStatusChangedAt", + "description": "Last BGP State Update by Date and Time", + "json_tag": "opStatusChangedAt" + }, + "OperationalStatus": { + "name": "OperationalStatus", + "description": "", + "json_tag": "operationalStatus" + } + } + }, + "BandwidthUtilization": { + "type_name": "BandwidthUtilization", + "description": "BandwidthUtilization Bandwidth utilization statistics (octet counters-based)", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Inbound": { + "name": "Inbound", + "description": "", + "json_tag": "inbound" + }, + "MetricInterval": { + "name": "MetricInterval", + "description": "An interval formatted value, indicating the time-interval the metric objects within the response represent", + "json_tag": "metricInterval" + }, + "Outbound": { + "name": "Outbound", + "description": "", + "json_tag": "outbound" + }, + "Unit": { + "name": "Unit", + "description": "", + "json_tag": "unit" + } + } + }, + "BasicAuth": { + "type_name": "BasicAuth", + "description": "BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth", + "fields": { + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "UserName": { + "name": "UserName", + "description": "", + "json_tag": "userName" + } + } + }, + "BulkPhysicalPort": { + "type_name": "BulkPhysicalPort", + "description": "BulkPhysicalPort Add to Lag request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "add physical ports to virtual port", + "json_tag": "data" + } + } + }, + "BulkPortRequest": { + "type_name": "BulkPortRequest", + "description": "BulkPortRequest Create bulk port request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + } + } + }, + "Change": { + "type_name": "Change", + "description": "Change Current state of latest connection change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Set when change flow starts", + "json_tag": "createdDateTime" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Information": { + "name": "Information", + "description": "Additional information", + "json_tag": "information" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "Set when change object is updated", + "json_tag": "updatedDateTime" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "Changelog": { + "type_name": "Changelog", + "description": "Changelog Change log", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "Created by User Key", + "json_tag": "createdBy" + }, + "CreatedByEmail": { + "name": "CreatedByEmail", + "description": "Created by User Email Address", + "json_tag": "createdByEmail" + }, + "CreatedByFullName": { + "name": "CreatedByFullName", + "description": "Created by User Full Name", + "json_tag": "createdByFullName" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Created by Date and Time", + "json_tag": "createdDateTime" + }, + "DeletedBy": { + "name": "DeletedBy", + "description": "Deleted by User Key", + "json_tag": "deletedBy" + }, + "DeletedByEmail": { + "name": "DeletedByEmail", + "description": "Deleted by User Email Address", + "json_tag": "deletedByEmail" + }, + "DeletedByFullName": { + "name": "DeletedByFullName", + "description": "Deleted by User Full Name", + "json_tag": "deletedByFullName" + }, + "DeletedDateTime": { + "name": "DeletedDateTime", + "description": "Deleted by Date and Time", + "json_tag": "deletedDateTime" + }, + "UpdatedBy": { + "name": "UpdatedBy", + "description": "Updated by User Key", + "json_tag": "updatedBy" + }, + "UpdatedByEmail": { + "name": "UpdatedByEmail", + "description": "Updated by User Email Address", + "json_tag": "updatedByEmail" + }, + "UpdatedByFullName": { + "name": "UpdatedByFullName", + "description": "Updated by User Full Name", + "json_tag": "updatedByFullName" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "Updated by Date and Time", + "json_tag": "updatedDateTime" + } + } + }, + "CloudEvent": { + "type_name": "CloudEvent", + "description": "CloudEvent Cloud Event object", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Authid": { + "name": "Authid", + "description": "Cloud Event user identifier", + "json_tag": "authid" + }, + "Authtype": { + "name": "Authtype", + "description": "Cloud Event auth type", + "json_tag": "authtype" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Datacontenttype": { + "name": "Datacontenttype", + "description": "Cloud Event data content type", + "json_tag": "datacontenttype" + }, + "Dataschema": { + "name": "Dataschema", + "description": "Cloud Event dataschema reference", + "json_tag": "dataschema" + }, + "Equinixalert": { + "name": "Equinixalert", + "description": "Equinix alert", + "json_tag": "equinixalert" + }, + "Equinixorganization": { + "name": "Equinixorganization", + "description": "Equinix organization identifier", + "json_tag": "equinixorganization" + }, + "Equinixproject": { + "name": "Equinixproject", + "description": "Equinix project identifier", + "json_tag": "equinixproject" + }, + "Id": { + "name": "Id", + "description": "Cloud Event identifier", + "json_tag": "id" + }, + "Severitynumber": { + "name": "Severitynumber", + "description": "Cloud Event severity number", + "json_tag": "severitynumber" + }, + "Severitytext": { + "name": "Severitytext", + "description": "Cloud Event severity text", + "json_tag": "severitytext" + }, + "Source": { + "name": "Source", + "description": "Cloud Event source", + "json_tag": "source" + }, + "Spec": { + "name": "Spec", + "description": "Cloud Event Open Telemetry specification", + "json_tag": "spec" + }, + "Subject": { + "name": "Subject", + "description": "Cloud Event subject", + "json_tag": "subject" + }, + "Time": { + "name": "Time", + "description": "Cloud Event time the event occurred", + "json_tag": "time" + }, + "Traceparent": { + "name": "Traceparent", + "description": "Cloud Event traceparent", + "json_tag": "traceparent" + }, + "Tracestate": { + "name": "Tracestate", + "description": "Cloud Event tracestate", + "json_tag": "tracestate" + }, + "Type": { + "name": "Type", + "description": "Equinix supported event type", + "json_tag": "type" + } + } + }, + "CloudEventData": { + "type_name": "CloudEventData", + "description": "CloudEventData struct for CloudEventData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Auth": { + "name": "Auth", + "description": "", + "json_tag": "auth" + }, + "Message": { + "name": "Message", + "description": "Cloud Event message", + "json_tag": "message" + }, + "Resource": { + "name": "Resource", + "description": "", + "json_tag": "resource" + } + } + }, + "CloudEventFilters": { + "type_name": "CloudEventFilters", + "description": "CloudEventFilters struct for CloudEventFilters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "CloudEventSearchRequest": { + "type_name": "CloudEventSearchRequest", + "description": "CloudEventSearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "CloudEventSimpleExpression": { + "type_name": "CloudEventSimpleExpression", + "description": "CloudEventSimpleExpression struct for CloudEventSimpleExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Possible operators to use on filters: * `=` - equal * `\u003e` - greater than * `\u003e=` - greater than or equal to * `\u003c` - less than * `\u003c=` - less than or equal to * `BETWEEN` - between * `IN` - in", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Possible field names to use on filters: * `/subject` - Cloud Event subject description * `/type` - Cloud Event type * `/time` - Time of Cloud Events * `/equinixproject` - Equinix Project of Cloud Events * `/equinixorganization` - Equinix Organization of Cloud Events", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "CloudRouter": { + "type_name": "CloudRouter", + "description": "CloudRouter Fabric Cloud Router object", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "ConnectionsCount": { + "name": "ConnectionsCount", + "description": "Number of connections associated with this Access point", + "json_tag": "connectionsCount" + }, + "EquinixAsn": { + "name": "EquinixAsn", + "description": "Equinix ASN", + "json_tag": "equinixAsn" + }, + "GatewayAttachmentsCount": { + "name": "GatewayAttachmentsCount", + "description": "Number of gateway attachments associated with this Access point", + "json_tag": "gatewayAttachmentsCount" + }, + "Href": { + "name": "Href", + "description": "Cloud Routers URI", + "json_tag": "href" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "MarketplaceSubscription": { + "name": "MarketplaceSubscription", + "description": "", + "json_tag": "marketplaceSubscription" + }, + "Name": { + "name": "Name", + "description": "Customer-provided Cloud Router name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Preferences for notifications on connection configuration or status changes", + "json_tag": "notifications" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned access point identifier", + "json_tag": "uuid" + } + } + }, + "CloudRouterActionRequest": { + "type_name": "CloudRouterActionRequest", + "description": "CloudRouterActionRequest Cloud router action request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Connection": { + "name": "Connection", + "description": "", + "json_tag": "connection" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "CloudRouterActionResponse": { + "type_name": "CloudRouterActionResponse", + "description": "CloudRouterActionResponse Cloud router actions response object", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Connection": { + "name": "Connection", + "description": "", + "json_tag": "connection" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Router": { + "name": "Router", + "description": "", + "json_tag": "router" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "CloudRouterActionsSearchExpression": { + "type_name": "CloudRouterActionsSearchExpression", + "description": "CloudRouterActionsSearchExpression struct for CloudRouterActionsSearchExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Possible operators to use on filters: * `=` - equal * `!=` - not equal * `\u003e` - greater than * `\u003e=` - greater than or equal to * `\u003c` - less than * `\u003c=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `~*` - case-insensitive like", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Possible field names to use on filters: * `/type` - type of update * `/state` - action state * `/connection/uuid` - connection uuid associated * `/_*` - all-category search", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "CloudRouterActionsSearchFilter": { + "type_name": "CloudRouterActionsSearchFilter", + "description": "CloudRouterActionsSearchFilter struct for CloudRouterActionsSearchFilter", + "fields": { + "CloudRouterActionsSearchExpression": { + "name": "CloudRouterActionsSearchExpression", + "description": "" + }, + "CloudRouterActionsSearchOrFilter": { + "name": "CloudRouterActionsSearchOrFilter", + "description": "" + } + } + }, + "CloudRouterActionsSearchFilters": { + "type_name": "CloudRouterActionsSearchFilters", + "description": "CloudRouterActionsSearchFilters struct for CloudRouterActionsSearchFilters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "CloudRouterActionsSearchOrFilter": { + "type_name": "CloudRouterActionsSearchOrFilter", + "description": "CloudRouterActionsSearchOrFilter struct for CloudRouterActionsSearchOrFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + } + } + }, + "CloudRouterActionsSearchRequest": { + "type_name": "CloudRouterActionsSearchRequest", + "description": "CloudRouterActionsSearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "CloudRouterActionsSearchResponse": { + "type_name": "CloudRouterActionsSearchResponse", + "description": "CloudRouterActionsSearchResponse struct for CloudRouterActionsSearchResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "CloudRouterActionsSearchSortCriteria": { + "type_name": "CloudRouterActionsSearchSortCriteria", + "description": "CloudRouterActionsSearchSortCriteria struct for CloudRouterActionsSearchSortCriteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "CloudRouterChange": { + "type_name": "CloudRouterChange", + "description": "CloudRouterChange Current state of latest CloudRouter change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Set when change flow starts", + "json_tag": "createdDateTime" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Information": { + "name": "Information", + "description": "Additional information", + "json_tag": "information" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "Set when change object is updated", + "json_tag": "updatedDateTime" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "CloudRouterChangeOperation": { + "type_name": "CloudRouterChangeOperation", + "description": "CloudRouterChangeOperation Fabric Cloud Router change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path inside document leading to updated parameter", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "new value for updated parameter", + "json_tag": "value" + } + } + }, + "CloudRouterCommand": { + "type_name": "CloudRouterCommand", + "description": "CloudRouterCommand Get Fabric Cloud Router Command response object", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "Customer-provided Cloud Router name", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Request": { + "name": "Request", + "description": "", + "json_tag": "request" + }, + "Response": { + "name": "Response", + "description": "", + "json_tag": "response" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "CloudRouterCommandPingResponse": { + "type_name": "CloudRouterCommandPingResponse", + "description": "CloudRouterCommandPingResponse struct for CloudRouterCommandPingResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Errors": { + "name": "Errors", + "description": "", + "json_tag": "errors" + }, + "Output": { + "name": "Output", + "description": "", + "json_tag": "output" + }, + "OutputStructuredPing": { + "name": "OutputStructuredPing", + "description": "", + "json_tag": "outputStructuredPing" + } + } + }, + "CloudRouterCommandPostRequest": { + "type_name": "CloudRouterCommandPostRequest", + "description": "CloudRouterCommandPostRequest Execute Cloud Router Command Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Customer-provided Cloud Router Command description", + "json_tag": "description" + }, + "Name": { + "name": "Name", + "description": "Customer-provided Cloud Router Command name", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Request": { + "name": "Request", + "description": "", + "json_tag": "request" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "CloudRouterCommandRequestConnection": { + "type_name": "CloudRouterCommandRequestConnection", + "description": "CloudRouterCommandRequestConnection Connection object for Cloud Router Command", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Uuid": { + "name": "Uuid", + "description": "Connection UUID", + "json_tag": "uuid" + } + } + }, + "CloudRouterCommandRequestPayload": { + "type_name": "CloudRouterCommandRequestPayload", + "description": "CloudRouterCommandRequestPayload Fabric Cloud Router Command Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DataBytes": { + "name": "DataBytes", + "description": "Ping Command DataBytes. This field is only applicable for commands of type `PING_COMMAND`.", + "json_tag": "dataBytes" + }, + "Destination": { + "name": "Destination", + "description": "Fabric Cloud Router Ping or Traceroute Command Destination", + "json_tag": "destination" + }, + "HopsMax": { + "name": "HopsMax", + "description": "Maximum number of hops for the traceroute command. This field is only applicable for commands of type `TRACEROUTE_COMMAND`.", + "json_tag": "hopsMax" + }, + "Probes": { + "name": "Probes", + "description": "Number of probes for Fabric Cloud Router Traceroute Command. This field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable.", + "json_tag": "probes" + }, + "SourceConnection": { + "name": "SourceConnection", + "description": "", + "json_tag": "sourceConnection" + }, + "Timeout": { + "name": "Timeout", + "description": "Timeout in seconds for Fabric Cloud Router Command: - For `PING_COMMAND`: Packet timeout duration. The default value is 5. - For `TRACEROUTE_COMMAND`: Probe timeout duration. The default value is 2 and it is not configurable.", + "json_tag": "timeout" + } + } + }, + "CloudRouterCommandRequestResponse": { + "type_name": "CloudRouterCommandRequestResponse", + "description": "CloudRouterCommandRequestResponse Fabric Cloud Router Command Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Count": { + "name": "Count", + "description": "Total number of ping requests. This field is only applicable for commands of type `PING_COMMAND`.", + "json_tag": "count" + }, + "DataBytes": { + "name": "DataBytes", + "description": "Ping Command DataBytes. This field is only applicable for commands of type `PING_COMMAND`.", + "json_tag": "dataBytes" + }, + "Destination": { + "name": "Destination", + "description": "Fabric Cloud Router Ping or Traceroute Command Destination", + "json_tag": "destination" + }, + "HopsMax": { + "name": "HopsMax", + "description": "Maximum number of hops for the traceroute command. This field is only applicable for commands of type `TRACEROUTE_COMMAND`.", + "json_tag": "hopsMax" + }, + "Interval": { + "name": "Interval", + "description": "Time in milliseconds between sending each packet. This field is only applicable for commands of type `PING_COMMAND`.", + "json_tag": "interval" + }, + "Probes": { + "name": "Probes", + "description": "Number of probes for Fabric Cloud Router Traceroute Command. This field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable.", + "json_tag": "probes" + }, + "SourceConnection": { + "name": "SourceConnection", + "description": "", + "json_tag": "sourceConnection" + }, + "Timeout": { + "name": "Timeout", + "description": "Timeout in seconds for Fabric Cloud Router Command: - For `PING_COMMAND`: Packet timeout duration. The default value is 5. - For `TRACEROUTE_COMMAND`: Probe timeout duration. The default value is 2 and it is not configurable.", + "json_tag": "timeout" + } + } + }, + "CloudRouterCommandResponse": { + "type_name": "CloudRouterCommandResponse", + "description": "CloudRouterCommandResponse - struct for CloudRouterCommandResponse", + "fields": { + "CloudRouterCommandPingResponse": { + "name": "CloudRouterCommandPingResponse", + "description": "" + }, + "CloudRouterCommandTracerouteResponse": { + "name": "CloudRouterCommandTracerouteResponse", + "description": "" + } + } + }, + "CloudRouterCommandSearchExpression": { + "type_name": "CloudRouterCommandSearchExpression", + "description": "CloudRouterCommandSearchExpression struct for CloudRouterCommandSearchExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Possible operators to use on filters: * `=` - equal * `!=` - not equal * `\u003e` - greater than * `\u003e=` - greater than or equal to * `\u003c` - less than * `\u003c=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `~*` - case-insensitive like", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Possible field names to use on filters: * `/type` - type of command * `/name` - name of command * `/state` - state of command * `/request/destination` - destination of command request * `/request/sourceConnection/uuid` - source connection uuid * `/_*` - all-category search", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "CloudRouterCommandSearchFilter": { + "type_name": "CloudRouterCommandSearchFilter", + "description": "CloudRouterCommandSearchFilter struct for CloudRouterCommandSearchFilter", + "fields": { + "CloudRouterCommandSearchExpression": { + "name": "CloudRouterCommandSearchExpression", + "description": "" + }, + "CloudRouterCommandSearchOrFilter": { + "name": "CloudRouterCommandSearchOrFilter", + "description": "" + } + } + }, + "CloudRouterCommandSearchFilters": { + "type_name": "CloudRouterCommandSearchFilters", + "description": "CloudRouterCommandSearchFilters struct for CloudRouterCommandSearchFilters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "CloudRouterCommandSearchOrFilter": { + "type_name": "CloudRouterCommandSearchOrFilter", + "description": "CloudRouterCommandSearchOrFilter struct for CloudRouterCommandSearchOrFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + } + } + }, + "CloudRouterCommandSearchRequest": { + "type_name": "CloudRouterCommandSearchRequest", + "description": "CloudRouterCommandSearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "CloudRouterCommandSearchResponse": { + "type_name": "CloudRouterCommandSearchResponse", + "description": "CloudRouterCommandSearchResponse struct for CloudRouterCommandSearchResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "CloudRouterCommandSearchSortCriteria": { + "type_name": "CloudRouterCommandSearchSortCriteria", + "description": "CloudRouterCommandSearchSortCriteria struct for CloudRouterCommandSearchSortCriteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "CloudRouterCommandTracerouteResponse": { + "type_name": "CloudRouterCommandTracerouteResponse", + "description": "CloudRouterCommandTracerouteResponse struct for CloudRouterCommandTracerouteResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Errors": { + "name": "Errors", + "description": "", + "json_tag": "errors" + }, + "Output": { + "name": "Output", + "description": "", + "json_tag": "output" + }, + "OutputStructuredTraceroute": { + "name": "OutputStructuredTraceroute", + "description": "", + "json_tag": "outputStructuredTraceroute" + } + } + }, + "CloudRouterFilter": { + "type_name": "CloudRouterFilter", + "description": "CloudRouterFilter struct for CloudRouterFilter", + "fields": { + "CloudRouterOrFilter": { + "name": "CloudRouterOrFilter", + "description": "" + }, + "CloudRouterSimpleExpression": { + "name": "CloudRouterSimpleExpression", + "description": "" + } + } + }, + "CloudRouterFilters": { + "type_name": "CloudRouterFilters", + "description": "CloudRouterFilters struct for CloudRouterFilters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "CloudRouterForGatewayAttachmentResponse": { + "type_name": "CloudRouterForGatewayAttachmentResponse", + "description": "CloudRouterForGatewayAttachmentResponse Response schema showing the Fabric Cloud Router on a Gateway Attachment. This schema defines the structure of the response showing the Cloud Router when a Gateway Attachment is done on it.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AttachmentStatus": { + "name": "AttachmentStatus", + "description": "", + "json_tag": "attachmentStatus" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "CloudRouterListForGatewayAttachment": { + "type_name": "CloudRouterListForGatewayAttachment", + "description": "CloudRouterListForGatewayAttachment struct for CloudRouterListForGatewayAttachment", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "CloudRouterOrFilter": { + "type_name": "CloudRouterOrFilter", + "description": "CloudRouterOrFilter struct for CloudRouterOrFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + } + } + }, + "CloudRouterPackage": { + "type_name": "CloudRouterPackage", + "description": "CloudRouterPackage Fabric Cloud Router Package", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "CrCountMax": { + "name": "CrCountMax", + "description": "CloudRouter package Max CloudRouter limit", + "json_tag": "crCountMax" + }, + "Description": { + "name": "Description", + "description": "Fabric Cloud Router Package description", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Cloud Router package URI", + "json_tag": "href" + }, + "RouteFilterSupported": { + "name": "RouteFilterSupported", + "description": "CloudRouter package route filter support", + "json_tag": "routeFilterSupported" + }, + "TotalIPv4RoutesMax": { + "name": "TotalIPv4RoutesMax", + "description": "Cloud Router package BGP IPv4 routes limit", + "json_tag": "totalIPv4RoutesMax" + }, + "TotalIPv6RoutesMax": { + "name": "TotalIPv6RoutesMax", + "description": "Cloud Router package BGP IPv6 routes limit", + "json_tag": "totalIPv6RoutesMax" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "VcBandwidthMax": { + "name": "VcBandwidthMax", + "description": "CloudRouter package Max Bandwidth limit", + "json_tag": "vcBandwidthMax" + }, + "VcCountMax": { + "name": "VcCountMax", + "description": "CloudRouter package Max Connection limit", + "json_tag": "vcCountMax" + } + } + }, + "CloudRouterPostRequest": { + "type_name": "CloudRouterPostRequest", + "description": "CloudRouterPostRequest struct for CloudRouterPostRequest", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "MarketplaceSubscription": { + "name": "MarketplaceSubscription", + "description": "", + "json_tag": "marketplaceSubscription" + }, + "Name": { + "name": "Name", + "description": "Customer-provided Cloud Router name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Preferences for notifications on connection configuration or status changes", + "json_tag": "notifications" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "CloudRouterPostRequestBase": { + "type_name": "CloudRouterPostRequestBase", + "description": "CloudRouterPostRequestBase Create Cloud Router", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "MarketplaceSubscription": { + "name": "MarketplaceSubscription", + "description": "", + "json_tag": "marketplaceSubscription" + }, + "Name": { + "name": "Name", + "description": "Customer-provided Cloud Router name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Preferences for notifications on connection configuration or status changes", + "json_tag": "notifications" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "CloudRouterPostRequestPackage": { + "type_name": "CloudRouterPostRequestPackage", + "description": "CloudRouterPostRequestPackage Fabric Cloud Router Package Type", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Href": { + "name": "Href", + "description": "Fabric Cloud Router URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "CloudRouterSearchRequest": { + "type_name": "CloudRouterSearchRequest", + "description": "CloudRouterSearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "CloudRouterSimpleExpression": { + "type_name": "CloudRouterSimpleExpression", + "description": "CloudRouterSimpleExpression struct for CloudRouterSimpleExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Possible operators to use on filters: * `=` - equal * `!=` - not equal * `\u003e` - greater than * `\u003e=` - greater than or equal to * `\u003c` - less than * `\u003c=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `ILIKE` - case-insensitive like", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Possible field names to use on filters: * `/project/projectId` - project id (mandatory) * `/name` - Fabric Cloud Router name * `/uuid` - Fabric Cloud Router uuid * `/state` - Fabric Cloud Router status * `/location/metroCode` - Fabric Cloud Router metro code * `/location/metroName` - Fabric Cloud Router metro name * `/package/code` - Fabric Cloud Router package * `/_*` - all-category search", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "CloudRouterSortCriteria": { + "type_name": "CloudRouterSortCriteria", + "description": "CloudRouterSortCriteria struct for CloudRouterSortCriteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "Configuration": { + "type_name": "Configuration", + "description": "Configuration stores the configuration of the API client", + "fields": { + "Debug": { + "name": "Debug", + "description": "", + "json_tag": "debug" + }, + "DefaultHeader": { + "name": "DefaultHeader", + "description": "", + "json_tag": "defaultHeader" + }, + "HTTPClient": { + "name": "HTTPClient", + "description": "" + }, + "Host": { + "name": "Host", + "description": "", + "json_tag": "host" + }, + "OperationServers": { + "name": "OperationServers", + "description": "" + }, + "Scheme": { + "name": "Scheme", + "description": "", + "json_tag": "scheme" + }, + "Servers": { + "name": "Servers", + "description": "" + }, + "UserAgent": { + "name": "UserAgent", + "description": "", + "json_tag": "userAgent" + } + } + }, + "ConnectedMetro": { + "type_name": "ConnectedMetro", + "description": "ConnectedMetro Arrays of objects containing latency data for the specified metros", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AvgLatency": { + "name": "AvgLatency", + "description": "Average latency (in milliseconds[ms]) between two specified metros.", + "json_tag": "avgLatency" + }, + "Code": { + "name": "Code", + "description": "Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area.", + "json_tag": "code" + }, + "Href": { + "name": "Href", + "description": "The Canonical URL at which the resource resides.", + "json_tag": "href" + }, + "RemoteVCBandwidthMax": { + "name": "RemoteVCBandwidthMax", + "description": "This field holds the Max Connection speed with connected metros", + "json_tag": "remoteVCBandwidthMax" + } + } + }, + "Connection": { + "type_name": "Connection", + "description": "Connection Connection specification", + "fields": { + "ASide": { + "name": "ASide", + "description": "", + "json_tag": "aSide" + }, + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Connection additional information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Connection bandwidth in Mbps", + "json_tag": "bandwidth" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Description": { + "name": "Description", + "description": "Customer-provided connection description", + "json_tag": "description" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "GeoScope": { + "name": "GeoScope", + "description": "", + "json_tag": "geoScope" + }, + "Href": { + "name": "Href", + "description": "Connection URI", + "json_tag": "href" + }, + "IsRemote": { + "name": "IsRemote", + "description": "Connection property derived from access point locations", + "json_tag": "isRemote" + }, + "MarketplaceSubscription": { + "name": "MarketplaceSubscription", + "description": "", + "json_tag": "marketplaceSubscription" + }, + "Name": { + "name": "Name", + "description": "Customer-provided connection name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Preferences for notifications on connection configuration or status changes", + "json_tag": "notifications" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Redundancy": { + "name": "Redundancy", + "description": "", + "json_tag": "redundancy" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned connection identifier", + "json_tag": "uuid" + }, + "ZSide": { + "name": "ZSide", + "description": "", + "json_tag": "zSide" + } + } + }, + "ConnectionAcceptanceData": { + "type_name": "ConnectionAcceptanceData", + "description": "ConnectionAcceptanceData Connection acceptance data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ProviderBandwidth": { + "name": "ProviderBandwidth", + "description": "Authorization key bandwidth in Mbps", + "json_tag": "providerBandwidth" + }, + "ZSide": { + "name": "ZSide", + "description": "", + "json_tag": "zSide" + } + } + }, + "ConnectionAction": { + "type_name": "ConnectionAction", + "description": "ConnectionAction Connection action", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Description": { + "name": "Description", + "description": "Connection rejection reason detail", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Connection action URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned connection identifier", + "json_tag": "uuid" + } + } + }, + "ConnectionActionRequest": { + "type_name": "ConnectionActionRequest", + "description": "ConnectionActionRequest Connection action request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Description": { + "name": "Description", + "description": "Connection rejection reason detail", + "json_tag": "description" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ConnectionChangeOperation": { + "type_name": "ConnectionChangeOperation", + "description": "ConnectionChangeOperation Connection change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "Handy shortcut for operation name", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path inside document leading to updated parameter", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "new value for updated parameter", + "json_tag": "value" + } + } + }, + "ConnectionCompanyProfile": { + "type_name": "ConnectionCompanyProfile", + "description": "ConnectionCompanyProfile Connection Company Profile Details", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "GlobalOrgId": { + "name": "GlobalOrgId", + "description": "global customer organization value", + "json_tag": "globalOrgId" + }, + "Id": { + "name": "Id", + "description": "company profile identifier", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "company profile name", + "json_tag": "name" + } + } + }, + "ConnectionInvitation": { + "type_name": "ConnectionInvitation", + "description": "ConnectionInvitation Connection Invitation Details", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CtrDraftOrderId": { + "name": "CtrDraftOrderId", + "description": "draft order id for invitation", + "json_tag": "ctrDraftOrderId" + }, + "Email": { + "name": "Email", + "description": "invitee email", + "json_tag": "email" + }, + "Message": { + "name": "Message", + "description": "invitation message", + "json_tag": "message" + } + } + }, + "ConnectionLink": { + "type_name": "ConnectionLink", + "description": "ConnectionLink struct for ConnectionLink", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "ConnectionOperation": { + "type_name": "ConnectionOperation", + "description": "ConnectionOperation Connection type-specific operational data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "EquinixStatus": { + "name": "EquinixStatus", + "description": "", + "json_tag": "equinixStatus" + }, + "Errors": { + "name": "Errors", + "description": "", + "json_tag": "errors" + }, + "OpStatusChangedAt": { + "name": "OpStatusChangedAt", + "description": "When connection transitioned into current operational status", + "json_tag": "opStatusChangedAt" + }, + "OperationalStatus": { + "name": "OperationalStatus", + "description": "", + "json_tag": "operationalStatus" + }, + "ProviderStatus": { + "name": "ProviderStatus", + "description": "", + "json_tag": "providerStatus" + } + } + }, + "ConnectionPostRequest": { + "type_name": "ConnectionPostRequest", + "description": "ConnectionPostRequest Create connection post request", + "fields": { + "ASide": { + "name": "ASide", + "description": "", + "json_tag": "aSide" + }, + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Connection additional information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Connection bandwidth in Mbps", + "json_tag": "bandwidth" + }, + "EndCustomer": { + "name": "EndCustomer", + "description": "", + "json_tag": "endCustomer" + }, + "GeoScope": { + "name": "GeoScope", + "description": "", + "json_tag": "geoScope" + }, + "MarketplaceSubscription": { + "name": "MarketplaceSubscription", + "description": "", + "json_tag": "marketplaceSubscription" + }, + "Name": { + "name": "Name", + "description": "Customer-provided connection name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Preferences for notifications on connection configuration or status changes", + "json_tag": "notifications" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Redundancy": { + "name": "Redundancy", + "description": "", + "json_tag": "redundancy" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "ZSide": { + "name": "ZSide", + "description": "", + "json_tag": "zSide" + } + } + }, + "ConnectionRedundancy": { + "type_name": "ConnectionRedundancy", + "description": "ConnectionRedundancy Connection redundancy configuration", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Group": { + "name": "Group", + "description": "Redundancy group identifier (UUID of primary connection)", + "json_tag": "group" + }, + "Priority": { + "name": "Priority", + "description": "", + "json_tag": "priority" + } + } + }, + "ConnectionResponse": { + "type_name": "ConnectionResponse", + "description": "ConnectionResponse ValidateResponse", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Additional information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Connection response data", + "json_tag": "data" + } + } + }, + "ConnectionRouteAggregationData": { + "type_name": "ConnectionRouteAggregationData", + "description": "ConnectionRouteAggregationData struct for ConnectionRouteAggregationData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AttachmentStatus": { + "name": "AttachmentStatus", + "description": "", + "json_tag": "attachmentStatus" + }, + "Href": { + "name": "Href", + "description": "Route Aggregation URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Route Aggregation identifier", + "json_tag": "uuid" + } + } + }, + "ConnectionRouteEntryFilter": { + "type_name": "ConnectionRouteEntryFilter", + "description": "ConnectionRouteEntryFilter struct for ConnectionRouteEntryFilter", + "fields": { + "ConnectionRouteEntryOrFilter": { + "name": "ConnectionRouteEntryOrFilter", + "description": "" + }, + "ConnectionRouteEntrySimpleExpression": { + "name": "ConnectionRouteEntrySimpleExpression", + "description": "" + } + } + }, + "ConnectionRouteEntryFilters": { + "type_name": "ConnectionRouteEntryFilters", + "description": "ConnectionRouteEntryFilters struct for ConnectionRouteEntryFilters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "ConnectionRouteEntryOrFilter": { + "type_name": "ConnectionRouteEntryOrFilter", + "description": "ConnectionRouteEntryOrFilter struct for ConnectionRouteEntryOrFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + } + } + }, + "ConnectionRouteEntrySimpleExpression": { + "type_name": "ConnectionRouteEntrySimpleExpression", + "description": "ConnectionRouteEntrySimpleExpression struct for ConnectionRouteEntrySimpleExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Possible operators to use on filters: * `=` - equal * `!=` - not equal * `\u003e` - greater than * `\u003e=` - greater than or equal to * `\u003c` - less than * `\u003c=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `~*` - case-insensitive like", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Possible field names to use on filters: * `/type` - Route table entry type * `/state` - Route table entry state * `/prefix` - Route table entry prefix * `/nextHop` - Route table entry nextHop * `/_*` - all-category search", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "ConnectionRouteFilterData": { + "type_name": "ConnectionRouteFilterData", + "description": "ConnectionRouteFilterData struct for ConnectionRouteFilterData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AttachmentStatus": { + "name": "AttachmentStatus", + "description": "", + "json_tag": "attachmentStatus" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Href": { + "name": "Href", + "description": "Route filter URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Route Filter identifier", + "json_tag": "uuid" + } + } + }, + "ConnectionRouteFiltersBase": { + "type_name": "ConnectionRouteFiltersBase", + "description": "ConnectionRouteFiltersBase struct for ConnectionRouteFiltersBase", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + } + } + }, + "ConnectionRouteSearchRequest": { + "type_name": "ConnectionRouteSearchRequest", + "description": "ConnectionRouteSearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "ConnectionRouteSortCriteria": { + "type_name": "ConnectionRouteSortCriteria", + "description": "ConnectionRouteSortCriteria struct for ConnectionRouteSortCriteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "ConnectionRouteTableEntry": { + "type_name": "ConnectionRouteTableEntry", + "description": "ConnectionRouteTableEntry Advertised and received route table entry object", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AsPath": { + "name": "AsPath", + "description": "", + "json_tag": "asPath" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Connection": { + "name": "Connection", + "description": "", + "json_tag": "connection" + }, + "LocalPreference": { + "name": "LocalPreference", + "description": "", + "json_tag": "localPreference" + }, + "MED": { + "name": "MED", + "description": "", + "json_tag": "MED" + }, + "NextHop": { + "name": "NextHop", + "description": "", + "json_tag": "nextHop" + }, + "Prefix": { + "name": "Prefix", + "description": "", + "json_tag": "prefix" + }, + "ProtocolType": { + "name": "ProtocolType", + "description": "", + "json_tag": "protocolType" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ConnectionRouteTableEntryConnection": { + "type_name": "ConnectionRouteTableEntryConnection", + "description": "ConnectionRouteTableEntryConnection struct for ConnectionRouteTableEntryConnection", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "ConnectionRouteTableEntrySearchResponse": { + "type_name": "ConnectionRouteTableEntrySearchResponse", + "description": "ConnectionRouteTableEntrySearchResponse struct for ConnectionRouteTableEntrySearchResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "ConnectionRoutingProtocolPostRequest": { + "type_name": "ConnectionRoutingProtocolPostRequest", + "description": "ConnectionRoutingProtocolPostRequest Create connection routing protocolpost request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Connection routing protocol configuration", + "json_tag": "data" + } + } + }, + "ConnectionSearchResponse": { + "type_name": "ConnectionSearchResponse", + "description": "ConnectionSearchResponse List of connections", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "ConnectionSide": { + "type_name": "ConnectionSide", + "description": "ConnectionSide Connection configuration object for each side of multi-segment connection", + "fields": { + "AccessPoint": { + "name": "AccessPoint", + "description": "", + "json_tag": "accessPoint" + }, + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Any additional information, which is not part of connection metadata or configuration", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CompanyProfile": { + "name": "CompanyProfile", + "description": "", + "json_tag": "companyProfile" + }, + "InternetAccess": { + "name": "InternetAccess", + "description": "", + "json_tag": "internetAccess" + }, + "Invitation": { + "name": "Invitation", + "description": "", + "json_tag": "invitation" + }, + "ServiceToken": { + "name": "ServiceToken", + "description": "", + "json_tag": "serviceToken" + } + } + }, + "ConnectionSideAdditionalInfo": { + "type_name": "ConnectionSideAdditionalInfo", + "description": "ConnectionSideAdditionalInfo Additional information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Key": { + "name": "Key", + "description": "Key", + "json_tag": "key" + }, + "Value": { + "name": "Value", + "description": "Value", + "json_tag": "value" + } + } + }, + "ConnectivitySource": { + "type_name": "ConnectivitySource", + "description": "ConnectivitySource Physical or virtual port that houses the connection.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "CustomField": { + "type_name": "CustomField", + "description": "CustomField Define Custom Attributes", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CaptureInEmail": { + "name": "CaptureInEmail", + "description": "capture this field as a part of email notification", + "json_tag": "captureInEmail" + }, + "DataType": { + "name": "DataType", + "description": "", + "json_tag": "dataType" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Label": { + "name": "Label", + "description": "", + "json_tag": "label" + }, + "Options": { + "name": "Options", + "description": "", + "json_tag": "options" + }, + "Required": { + "name": "Required", + "description": "", + "json_tag": "required" + } + } + }, + "DeploymentTopology": { + "type_name": "DeploymentTopology", + "description": "DeploymentTopology struct for DeploymentTopology", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "DetectionMethod": { + "type_name": "DetectionMethod", + "description": "DetectionMethod struct for DetectionMethod", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CriticalThreshold": { + "name": "CriticalThreshold", + "description": "Stream alert rule metric critical threshold", + "json_tag": "criticalThreshold" + }, + "Operand": { + "name": "Operand", + "description": "", + "json_tag": "operand" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "WarningThreshold": { + "name": "WarningThreshold", + "description": "Stream alert rule metric warning threshold", + "json_tag": "warningThreshold" + }, + "WindowSize": { + "name": "WindowSize", + "description": "Stream alert rule metric window size", + "json_tag": "windowSize" + } + } + }, + "DetectionMethodResponse": { + "type_name": "DetectionMethodResponse", + "description": "DetectionMethodResponse struct for DetectionMethodResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CriticalThreshold": { + "name": "CriticalThreshold", + "description": "Stream alert rule metric critical threshold", + "json_tag": "criticalThreshold" + }, + "Operand": { + "name": "Operand", + "description": "", + "json_tag": "operand" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "WarningThreshold": { + "name": "WarningThreshold", + "description": "Stream alert rule metric warning threshold", + "json_tag": "warningThreshold" + }, + "WindowSize": { + "name": "WindowSize", + "description": "Stream alert rule metric window size", + "json_tag": "windowSize" + } + } + }, + "DirectConnectionIpv4": { + "type_name": "DirectConnectionIpv4", + "description": "DirectConnectionIpv4 struct for DirectConnectionIpv4", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "EquinixIfaceIp": { + "name": "EquinixIfaceIp", + "description": "Equinix side Interface IP address", + "json_tag": "equinixIfaceIp" + } + } + }, + "DirectConnectionIpv6": { + "type_name": "DirectConnectionIpv6", + "description": "DirectConnectionIpv6 struct for DirectConnectionIpv6", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "EquinixIfaceIp": { + "name": "EquinixIfaceIp", + "description": "Equinix side Interface IP address", + "json_tag": "equinixIfaceIp" + } + } + }, + "Direction": { + "type_name": "Direction", + "description": "Direction Directional statistics", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Max": { + "name": "Max", + "description": "Max bandwidth within request time range, represented in units specified by response \\\"units\\\" field", + "json_tag": "max" + }, + "Mean": { + "name": "Mean", + "description": "Mean bandwidth within request time range, represented in units specified by response \\\"units\\\" field", + "json_tag": "mean" + }, + "Metrics": { + "name": "Metrics", + "description": "Bandwidth utilization statistics for a specified interval.", + "json_tag": "metrics" + } + } + }, + "EndCustomer": { + "type_name": "EndCustomer", + "description": "EndCustomer struct for EndCustomer", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "IsDisclosed": { + "name": "IsDisclosed", + "description": "Indicate if endCustomer info should be disclosed or not", + "json_tag": "isDisclosed" + }, + "MdmId": { + "name": "MdmId", + "description": "", + "json_tag": "mdmId" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "Error": { + "type_name": "Error", + "description": "Error Error Response with details", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CorrelationId": { + "name": "CorrelationId", + "description": "", + "json_tag": "correlationId" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "ErrorCode": { + "name": "ErrorCode", + "description": "", + "json_tag": "errorCode\" validate:\"regexp=^EQ-\\\\\\\\d{7}$" + }, + "ErrorMessage": { + "name": "ErrorMessage", + "description": "", + "json_tag": "errorMessage" + }, + "Help": { + "name": "Help", + "description": "", + "json_tag": "help" + } + } + }, + "Expression": { + "type_name": "Expression", + "description": "Expression struct for Expression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + }, + "Operator": { + "name": "Operator", + "description": "", + "json_tag": "operator" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "FabricBGPConnectionIpv4": { + "type_name": "FabricBGPConnectionIpv4", + "description": "FabricBGPConnectionIpv4 Defines the structure for a BGP IPv4 connection, including customer and Equinix peering IP addresses.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerIp": { + "name": "CustomerIp", + "description": "Customer side peering ip", + "json_tag": "customerIp" + }, + "EquinixIp": { + "name": "EquinixIp", + "description": "Equinix side peering ip", + "json_tag": "equinixIp" + } + } + }, + "FabricCloudRouterPackages": { + "type_name": "FabricCloudRouterPackages", + "description": "FabricCloudRouterPackages Cloud Router package", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + } + } + }, + "FabricCloudRouterPrice": { + "type_name": "FabricCloudRouterPrice", + "description": "FabricCloudRouterPrice Cloud Router Product configuration", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "Uuid": { + "name": "Uuid", + "description": "Unique identifier assigned to the Cloud Router", + "json_tag": "uuid" + } + } + }, + "FabricConnection": { + "type_name": "FabricConnection", + "description": "FabricConnection The OrchestratorProvider schema defines the configuration for a network connection and deployment properties, offering a detailed overview of the connection's characteristics and requirements.", + "fields": { + "ASide": { + "name": "ASide", + "description": "", + "json_tag": "aSide" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "", + "json_tag": "bandwidth" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Redundancy": { + "name": "Redundancy", + "description": "", + "json_tag": "redundancy" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "ZSide": { + "name": "ZSide", + "description": "", + "json_tag": "zSide" + } + } + }, + "FabricConnectionResponse": { + "type_name": "FabricConnectionResponse", + "description": "FabricConnectionResponse struct for FabricConnectionResponse", + "fields": { + "ASide": { + "name": "ASide", + "description": "", + "json_tag": "aSide" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "", + "json_tag": "bandwidth" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Href": { + "name": "Href", + "description": "Connection URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Redundancy": { + "name": "Redundancy", + "description": "", + "json_tag": "redundancy" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned connection identifier", + "json_tag": "uuid" + }, + "ZSide": { + "name": "ZSide", + "description": "", + "json_tag": "zSide" + } + } + }, + "FabricIPWAN": { + "type_name": "FabricIPWAN", + "description": "FabricIPWAN The IPWAN schema defines the structure for a network IPWAN within the orchestrator system.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Scope": { + "name": "Scope", + "description": "", + "json_tag": "scope" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned access point identifier", + "json_tag": "uuid" + } + } + }, + "FabricIPWANConnection": { + "type_name": "FabricIPWANConnection", + "description": "FabricIPWANConnection The OrchestratorProvider schema defines the configuration for a IPWAN connection and deployment properties, offering a detailed overview of the connection's characteristics and requirements.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "", + "json_tag": "bandwidth" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "FabricIPWANConnectionResponse": { + "type_name": "FabricIPWANConnectionResponse", + "description": "FabricIPWANConnectionResponse struct for FabricIPWANConnectionResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "", + "json_tag": "bandwidth" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Href": { + "name": "Href", + "description": "IPWAN Connection URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned ipwan connection identifier", + "json_tag": "uuid" + } + } + }, + "FabricIPWANResponse": { + "type_name": "FabricIPWANResponse", + "description": "FabricIPWANResponse struct for FabricIPWANResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Href": { + "name": "Href", + "description": "IPWAN URI", + "json_tag": "href" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Scope": { + "name": "Scope", + "description": "", + "json_tag": "scope" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned IPWAN identifier", + "json_tag": "uuid" + } + } + }, + "FabricProvider": { + "type_name": "FabricProvider", + "description": "FabricProvider The Orchestrator Fabric Providers schema defines the structure for the orchestrator fabric provider configuration.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Resources": { + "name": "Resources", + "description": "", + "json_tag": "resources" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "FabricProviderResource": { + "type_name": "FabricProviderResource", + "description": "FabricProviderResource - struct for FabricProviderResource", + "fields": { + "FabricConnection": { + "name": "FabricConnection", + "description": "" + }, + "FabricIPWAN": { + "name": "FabricIPWAN", + "description": "" + }, + "FabricIPWANConnection": { + "name": "FabricIPWANConnection", + "description": "" + }, + "FabricRouteProtocols": { + "name": "FabricRouteProtocols", + "description": "" + }, + "FabricRouter": { + "name": "FabricRouter", + "description": "" + } + } + }, + "FabricProviderResourceResponse": { + "type_name": "FabricProviderResourceResponse", + "description": "FabricProviderResourceResponse - struct for FabricProviderResourceResponse", + "fields": { + "FabricConnectionResponse": { + "name": "FabricConnectionResponse", + "description": "" + }, + "FabricIPWANConnectionResponse": { + "name": "FabricIPWANConnectionResponse", + "description": "" + }, + "FabricIPWANResponse": { + "name": "FabricIPWANResponse", + "description": "" + }, + "FabricRouteProtocolsResponse": { + "name": "FabricRouteProtocolsResponse", + "description": "" + }, + "FabricRouterResponse": { + "name": "FabricRouterResponse", + "description": "" + } + } + }, + "FabricProviderResponse": { + "type_name": "FabricProviderResponse", + "description": "FabricProviderResponse The response from the orchestrator when querying for fabric provider resources. This response contains a list of resources that are managed by the fabric provider. The resources can be routers, connections, or route protocols.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Resources": { + "name": "Resources", + "description": "", + "json_tag": "resources" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "FabricRouteProtocols": { + "type_name": "FabricRouteProtocols", + "description": "FabricRouteProtocols - The RouteProtocols schema specifies the supported routing protocols for orchestrator providers. It defines the structure and configuration options for each protocol type.", + "fields": { + "FabricRoutingProtocolBGPType": { + "name": "FabricRoutingProtocolBGPType", + "description": "" + } + } + }, + "FabricRouteProtocolsResponse": { + "type_name": "FabricRouteProtocolsResponse", + "description": "FabricRouteProtocolsResponse - struct for FabricRouteProtocolsResponse", + "fields": { + "FabricRoutingProtocolBGPType": { + "name": "FabricRoutingProtocolBGPType", + "description": "" + } + } + }, + "FabricRouter": { + "type_name": "FabricRouter", + "description": "FabricRouter The Router schema defines the structure for a network router within the orchestrator system.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned access point identifier", + "json_tag": "uuid" + } + } + }, + "FabricRouterResponse": { + "type_name": "FabricRouterResponse", + "description": "FabricRouterResponse struct for FabricRouterResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Href": { + "name": "Href", + "description": "Cloud Routers URI", + "json_tag": "href" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned cloud router identifier", + "json_tag": "uuid" + } + } + }, + "FabricRoutingProtocolBGPType": { + "type_name": "FabricRoutingProtocolBGPType", + "description": "FabricRoutingProtocolBGPType Defines the structure for BGP routing protocol configuration, including protocol type, BGP IPv4 settings, customer ASN, authentication key, and deployment properties.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AsOverrideEnabled": { + "name": "AsOverrideEnabled", + "description": "Enable AS number override", + "json_tag": "asOverrideEnabled" + }, + "BgpAuthKey": { + "name": "BgpAuthKey", + "description": "BGP authorization key", + "json_tag": "bgpAuthKey" + }, + "BgpIpv4": { + "name": "BgpIpv4", + "description": "", + "json_tag": "bgpIpv4" + }, + "CustomerAsn": { + "name": "CustomerAsn", + "description": "Customer asn", + "json_tag": "customerAsn" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned route protocol identifier", + "json_tag": "uuid" + } + } + }, + "FilterBody": { + "type_name": "FilterBody", + "description": "FilterBody Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + } + } + }, + "GCPCloudRouter": { + "type_name": "GCPCloudRouter", + "description": "GCPCloudRouter The GCP CloudRouter schema defines the structure for the gcp cloud router configuration, including provider type, VPC, subnet, and deployment properties.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "SubnetId": { + "name": "SubnetId", + "description": "", + "json_tag": "subnetId" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "VpcId": { + "name": "VpcId", + "description": "", + "json_tag": "vpcId" + } + } + }, + "GCPCloudRouterResponse": { + "type_name": "GCPCloudRouterResponse", + "description": "GCPCloudRouterResponse struct for GCPCloudRouterResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "Id": { + "name": "Id", + "description": "Cloud Router id.", + "json_tag": "id" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "SubnetId": { + "name": "SubnetId", + "description": "", + "json_tag": "subnetId" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "VpcId": { + "name": "VpcId", + "description": "", + "json_tag": "vpcId" + } + } + }, + "GCPPermission": { + "type_name": "GCPPermission", + "description": "GCPPermission Provides the GCP permission configuration for the orchestrator. This permission is used to manage the GCP resources and their access control.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeploymentProperties": { + "name": "DeploymentProperties", + "description": "", + "json_tag": "deploymentProperties" + }, + "PoolId": { + "name": "PoolId", + "description": "", + "json_tag": "poolId" + }, + "ProjectId": { + "name": "ProjectId", + "description": "", + "json_tag": "projectId" + }, + "ProviderId": { + "name": "ProviderId", + "description": "", + "json_tag": "providerId" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "GCPProvider": { + "type_name": "GCPProvider", + "description": "GCPProvider The Orchestrator GCP Providers schema defines the structure for the orchestrator gcp provider configuration.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Resources": { + "name": "Resources", + "description": "", + "json_tag": "resources" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "GCPProviderResource": { + "type_name": "GCPProviderResource", + "description": "GCPProviderResource - struct for GCPProviderResource", + "fields": { + "GCPCloudRouter": { + "name": "GCPCloudRouter", + "description": "" + }, + "GCPPermission": { + "name": "GCPPermission", + "description": "" + } + } + }, + "GCPProviderResourceResponse": { + "type_name": "GCPProviderResourceResponse", + "description": "GCPProviderResourceResponse - struct for GCPProviderResourceResponse", + "fields": { + "GCPCloudRouterResponse": { + "name": "GCPCloudRouterResponse", + "description": "" + }, + "GCPPermission": { + "name": "GCPPermission", + "description": "" + } + } + }, + "GCPProviderResponse": { + "type_name": "GCPProviderResponse", + "description": "GCPProviderResponse struct for GCPProviderResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Resources": { + "name": "Resources", + "description": "", + "json_tag": "resources" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "GatewayAttachmentListResponse": { + "type_name": "GatewayAttachmentListResponse", + "description": "GatewayAttachmentListResponse struct for GatewayAttachmentListResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GatewayAttachmentResponse": { + "type_name": "GatewayAttachmentResponse", + "description": "GatewayAttachmentResponse Schema representing a Gateway attaching or detaching on a Cloud Router. This schema defines the structure of the response returned when a Gateway is attached or detached to a Cloud Router.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AttachmentStatus": { + "name": "AttachmentStatus", + "description": "", + "json_tag": "attachmentStatus" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Errors": { + "name": "Errors", + "description": "", + "json_tag": "errors" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "GenericOpenAPIError": { + "type_name": "GenericOpenAPIError", + "description": "GenericOpenAPIError Provides access to the body, error and model on returned errors.", + "fields": { + "body": { + "name": "body", + "description": "" + }, + "error": { + "name": "error", + "description": "" + }, + "model": { + "name": "model", + "description": "" + } + } + }, + "GeoCoordinates": { + "type_name": "GeoCoordinates", + "description": "GeoCoordinates Geographic location data of Fabric Metro", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Latitude": { + "name": "Latitude", + "description": "Latitude of a Fabric Metro", + "json_tag": "latitude" + }, + "Longitude": { + "name": "Longitude", + "description": "Longitude of a Fabric Metro", + "json_tag": "longitude" + } + } + }, + "GetAllCloudRouterCommands": { + "type_name": "GetAllCloudRouterCommands", + "description": "GetAllCloudRouterCommands List of Fabric Cloud Router Command", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetAllConnectionRouteAggregationsResponse": { + "type_name": "GetAllConnectionRouteAggregationsResponse", + "description": "GetAllConnectionRouteAggregationsResponse struct for GetAllConnectionRouteAggregationsResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of Route Aggregations attached to a Connection", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetAllConnectionRouteFiltersResponse": { + "type_name": "GetAllConnectionRouteFiltersResponse", + "description": "GetAllConnectionRouteFiltersResponse struct for GetAllConnectionRouteFiltersResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of Route Filters attached to a Connection", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetAllStreamAlertRuleResponse": { + "type_name": "GetAllStreamAlertRuleResponse", + "description": "GetAllStreamAlertRuleResponse struct for GetAllStreamAlertRuleResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetAllStreamAssetResponse": { + "type_name": "GetAllStreamAssetResponse", + "description": "GetAllStreamAssetResponse struct for GetAllStreamAssetResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetAllStreamResponse": { + "type_name": "GetAllStreamResponse", + "description": "GetAllStreamResponse struct for GetAllStreamResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetAllStreamSubscriptionResponse": { + "type_name": "GetAllStreamSubscriptionResponse", + "description": "GetAllStreamSubscriptionResponse struct for GetAllStreamSubscriptionResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetCloudEventsByAssetResponse": { + "type_name": "GetCloudEventsByAssetResponse", + "description": "GetCloudEventsByAssetResponse struct for GetCloudEventsByAssetResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetMetricsByAssetResponse": { + "type_name": "GetMetricsByAssetResponse", + "description": "GetMetricsByAssetResponse struct for GetMetricsByAssetResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetResponse": { + "type_name": "GetResponse", + "description": "GetResponse struct for GetResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of Routing Protocols", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetRouteAggregationGetConnectionsResponse": { + "type_name": "GetRouteAggregationGetConnectionsResponse", + "description": "GetRouteAggregationGetConnectionsResponse struct for GetRouteAggregationGetConnectionsResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of Connections using a Route Aggregation", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetRouteAggregationRulesResponse": { + "type_name": "GetRouteAggregationRulesResponse", + "description": "GetRouteAggregationRulesResponse struct for GetRouteAggregationRulesResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of Route Aggregation Rules", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetRouteFilterGetConnectionsResponse": { + "type_name": "GetRouteFilterGetConnectionsResponse", + "description": "GetRouteFilterGetConnectionsResponse struct for GetRouteFilterGetConnectionsResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of Connections using a Route Filter", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "GetRouteFilterRulesResponse": { + "type_name": "GetRouteFilterRulesResponse", + "description": "GetRouteFilterRulesResponse struct for GetRouteFilterRulesResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of Route Filter Rules", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "HealthResponse": { + "type_name": "HealthResponse", + "description": "HealthResponse GET Services Health", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ApiServices": { + "name": "ApiServices", + "description": "", + "json_tag": "apiServices" + }, + "Href": { + "name": "Href", + "description": "The Canonical URL at which the resource resides.", + "json_tag": "href" + }, + "Release": { + "name": "Release", + "description": "release details.", + "json_tag": "release" + }, + "State": { + "name": "State", + "description": "status of a service", + "json_tag": "state" + }, + "Version": { + "name": "Version", + "description": "Indicator of a version", + "json_tag": "version" + } + } + }, + "Hop": { + "type_name": "Hop", + "description": "Hop struct for Hop", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Hop": { + "name": "Hop", + "description": "", + "json_tag": "hop" + }, + "Probes": { + "name": "Probes", + "description": "", + "json_tag": "probes" + } + } + }, + "HopProbes": { + "type_name": "HopProbes", + "description": "HopProbes struct for HopProbes", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Annotation": { + "name": "Annotation", + "description": "", + "json_tag": "annotation" + }, + "Asn": { + "name": "Asn", + "description": "", + "json_tag": "asn" + }, + "Ip": { + "name": "Ip", + "description": "", + "json_tag": "ip" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Rtt": { + "name": "Rtt", + "description": "", + "json_tag": "rtt" + } + } + }, + "Interface": { + "type_name": "Interface", + "description": "Interface Interface Information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Interface URI", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "Interface id", + "json_tag": "id" + }, + "ProjectId": { + "name": "ProjectId", + "description": "Interface Project ID", + "json_tag": "projectId" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned Interface identifier", + "json_tag": "uuid" + } + } + }, + "InternetAccess": { + "type_name": "InternetAccess", + "description": "InternetAccess Internet Access Details", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Uuid": { + "name": "Uuid", + "description": "Internet Access Service Identifier", + "json_tag": "uuid" + } + } + }, + "IpBlockPrice": { + "type_name": "IpBlockPrice", + "description": "IpBlockPrice IP Block Product configuration", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "PrefixLength": { + "name": "PrefixLength", + "description": "", + "json_tag": "prefixLength" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Either uuid or rest of attributes are required", + "json_tag": "uuid" + } + } + }, + "Ipv4": { + "type_name": "Ipv4", + "description": "Ipv4 EPT service network information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DefaultGateway": { + "name": "DefaultGateway", + "description": "Gateway Interface IP address", + "json_tag": "defaultGateway" + }, + "NetworkMask": { + "name": "NetworkMask", + "description": "Network Mask", + "json_tag": "networkMask" + }, + "Primary": { + "name": "Primary", + "description": "Primary Timing Server IP Address", + "json_tag": "primary" + }, + "Secondary": { + "name": "Secondary", + "description": "Secondary Timing Server IP Address", + "json_tag": "secondary" + } + } + }, + "JsonPatchOperation": { + "type_name": "JsonPatchOperation", + "description": "JsonPatchOperation - Service Profile Access Points", + "fields": { + "AddOperation": { + "name": "AddOperation", + "description": "" + }, + "RemoveOperation": { + "name": "RemoveOperation", + "description": "" + }, + "ReplaceOperation": { + "name": "ReplaceOperation", + "description": "" + } + } + }, + "Link": { + "type_name": "Link", + "description": "Link struct for Link", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Authenticate": { + "name": "Authenticate", + "description": "Authentication required or not", + "json_tag": "authenticate" + }, + "ContentType": { + "name": "ContentType", + "description": "Content type for the response", + "json_tag": "contentType" + }, + "Href": { + "name": "Href", + "description": "Resource URI", + "json_tag": "href" + }, + "Method": { + "name": "Method", + "description": "Http method type", + "json_tag": "method" + }, + "Rel": { + "name": "Rel", + "description": "OperationId from Swagger hub spec", + "json_tag": "rel" + } + } + }, + "LinkAggregationGroup": { + "type_name": "LinkAggregationGroup", + "description": "LinkAggregationGroup Link aggregation group (LAG) preferences and settings.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Enabled": { + "name": "Enabled", + "description": "Parameter showing whether LAG configuration is mandatory. The default is false.", + "json_tag": "enabled" + } + } + }, + "LinkProtocolConnection": { + "type_name": "LinkProtocolConnection", + "description": "LinkProtocolConnection Connection details of Link Protocol", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "", + "json_tag": "bandwidth" + }, + "Href": { + "name": "Href", + "description": "Connection URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "LinkProtocolGetResponse": { + "type_name": "LinkProtocolGetResponse", + "description": "LinkProtocolGetResponse List of Vlans", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "LinkProtocolResponse": { + "type_name": "LinkProtocolResponse", + "description": "LinkProtocolResponse Link Protocol response", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Asset": { + "name": "Asset", + "description": "", + "json_tag": "asset" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Href": { + "name": "Href", + "description": "LinkProtocol URI", + "json_tag": "href" + }, + "ServiceToken": { + "name": "ServiceToken", + "description": "", + "json_tag": "serviceToken" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "SubInterface": { + "name": "SubInterface", + "description": "", + "json_tag": "subInterface" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned network identifier", + "json_tag": "uuid" + }, + "VlanCTag": { + "name": "VlanCTag", + "description": "", + "json_tag": "vlanCTag" + }, + "VlanCTagMax": { + "name": "VlanCTagMax", + "description": "", + "json_tag": "vlanCTagMax" + }, + "VlanCTagMin": { + "name": "VlanCTagMin", + "description": "", + "json_tag": "vlanCTagMin" + }, + "VlanSTag": { + "name": "VlanSTag", + "description": "", + "json_tag": "vlanSTag" + }, + "VlanTag": { + "name": "VlanTag", + "description": "", + "json_tag": "vlanTag" + }, + "VlanTagMax": { + "name": "VlanTagMax", + "description": "", + "json_tag": "vlanTagMax" + }, + "VlanTagMin": { + "name": "VlanTagMin", + "description": "", + "json_tag": "vlanTagMin" + }, + "Vni": { + "name": "Vni", + "description": "", + "json_tag": "vni" + } + } + }, + "LinkProtocolServiceToken": { + "type_name": "LinkProtocolServiceToken", + "description": "LinkProtocolServiceToken Service Token details of Link Protocol", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "", + "json_tag": "bandwidth" + }, + "Href": { + "name": "Href", + "description": "Service Token URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "MarketingInfo": { + "type_name": "MarketingInfo", + "description": "MarketingInfo struct for MarketingInfo", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Logo": { + "name": "Logo", + "description": "Logo file name", + "json_tag": "logo" + }, + "ProcessSteps": { + "name": "ProcessSteps", + "description": "", + "json_tag": "processSteps" + }, + "Promotion": { + "name": "Promotion", + "description": "Profile promotion on marketplace", + "json_tag": "promotion" + } + } + }, + "MarketplaceSubscription": { + "type_name": "MarketplaceSubscription", + "description": "MarketplaceSubscription Equinix Fabric Entity for Marketplace Subscription", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Marketplace Subscription URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned Marketplace Subscription identifier", + "json_tag": "uuid" + } + } + }, + "Md5": { + "type_name": "Md5", + "description": "Md5 struct for Md5", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Key": { + "name": "Key", + "description": "The plaintext authentication key. Must be Base64 encoded. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters.", + "json_tag": "key" + }, + "KeyNumber": { + "name": "KeyNumber", + "description": "The authentication Key ID.", + "json_tag": "keyNumber" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "MetalInterconnection": { + "type_name": "MetalInterconnection", + "description": "MetalInterconnection Metal Interconnection", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix Metal Interconnection", + "json_tag": "uuid" + } + } + }, + "Metric": { + "type_name": "Metric", + "description": "Metric Metric object", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Datapoints": { + "name": "Datapoints", + "description": "Metric data points", + "json_tag": "datapoints" + }, + "Interval": { + "name": "Interval", + "description": "Metric interval (set automatically based on search range)", + "json_tag": "interval" + }, + "Name": { + "name": "Name", + "description": "Metric name", + "json_tag": "name" + }, + "Resource": { + "name": "Resource", + "description": "", + "json_tag": "resource" + }, + "Summary": { + "name": "Summary", + "description": "Metric summary", + "json_tag": "summary" + }, + "Type": { + "name": "Type", + "description": "Equinix supported metric type", + "json_tag": "type" + }, + "Unit": { + "name": "Unit", + "description": "Metric unit", + "json_tag": "unit" + } + } + }, + "MetricDatapoints": { + "type_name": "MetricDatapoints", + "description": "MetricDatapoints struct for MetricDatapoints", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "EndDateTime": { + "name": "EndDateTime", + "description": "Datapoint end date and time", + "json_tag": "endDateTime" + }, + "StartDateTime": { + "name": "StartDateTime", + "description": "Datapoint start date and time", + "json_tag": "startDateTime" + }, + "Value": { + "name": "Value", + "description": "Datapoint value", + "json_tag": "value" + } + } + }, + "MetricFilters": { + "type_name": "MetricFilters", + "description": "MetricFilters struct for MetricFilters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "MetricResource": { + "type_name": "MetricResource", + "description": "MetricResource Metric resource", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Metric resource description", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Metric resource href", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "Metric resource name", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "Metric resource type", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Metric resource UUID", + "json_tag": "uuid" + } + } + }, + "MetricSelector": { + "type_name": "MetricSelector", + "description": "MetricSelector struct for MetricSelector", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Include": { + "name": "Include", + "description": "Stream alert rule filtered by metric name", + "json_tag": "include" + } + } + }, + "MetricSelectorResponse": { + "type_name": "MetricSelectorResponse", + "description": "MetricSelectorResponse struct for MetricSelectorResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Include": { + "name": "Include", + "description": "Stream alert rule filtered by metric name", + "json_tag": "include" + } + } + }, + "MetricSimpleExpression": { + "type_name": "MetricSimpleExpression", + "description": "MetricSimpleExpression struct for MetricSimpleExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Possible operators to use on filters: * `=` - equal * `\u003e` - greater than * `\u003e=` - greater than or equal to * `\u003c` - less than * `\u003c=` - less than or equal to * `BETWEEN` - between * `IN` - in", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Possible field names to use on filters: * `/subject` - Metric subject description (required and limited to 1 value) * `/name` - Metric names (required) * `/dataPoints/endDateTime` - Time of Metrics", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "Metrics": { + "type_name": "Metrics", + "description": "Metrics Bandwidth utilization statistics for a specified interval.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "IntervalEndTimestamp": { + "name": "IntervalEndTimestamp", + "description": "Interval end timestamp", + "json_tag": "intervalEndTimestamp" + }, + "Max": { + "name": "Max", + "description": "Max bandwidth within statistics object time interval, represented in units specified by response \\\"units\\\" field", + "json_tag": "max" + }, + "Mean": { + "name": "Mean", + "description": "Mean bandwidth within statistics object time interval, represented in units specified by response \\\"units\\\" field", + "json_tag": "mean" + } + } + }, + "MetricsSearchRequest": { + "type_name": "MetricsSearchRequest", + "description": "MetricsSearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "Metro": { + "type_name": "Metro", + "description": "Metro GET Metros retrieves all Equinix® Fabric™ metros, as well as latency data for each location.This performance data helps network planning engineers and administrators make strategic decisions about port locations and traffic routes.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "Code Assigned to an Equinix IBX data center in a specified metropolitan area.", + "json_tag": "code" + }, + "ConnectedMetros": { + "name": "ConnectedMetros", + "description": "", + "json_tag": "connectedMetros" + }, + "EquinixAsn": { + "name": "EquinixAsn", + "description": "Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.", + "json_tag": "equinixAsn" + }, + "GeoCoordinates": { + "name": "GeoCoordinates", + "description": "", + "json_tag": "geoCoordinates" + }, + "GeoScopes": { + "name": "GeoScopes", + "description": "List of supported geographic boundaries of a Fabric Metro.", + "json_tag": "geoScopes" + }, + "Href": { + "name": "Href", + "description": "The Canonical URL at which the resource resides.", + "json_tag": "href" + }, + "LocalVCBandwidthMax": { + "name": "LocalVCBandwidthMax", + "description": "This field holds Max Connection speed with in the metro", + "json_tag": "localVCBandwidthMax" + }, + "Name": { + "name": "Name", + "description": "Name of the region in which the data center is located.", + "json_tag": "name" + }, + "Region": { + "name": "Region", + "description": "Board geographic area in which the data center is located", + "json_tag": "region" + }, + "Services": { + "name": "Services", + "description": "", + "json_tag": "services" + }, + "Type": { + "name": "Type", + "description": "Indicator of a Fabric Metro", + "json_tag": "type" + } + } + }, + "MetroError": { + "type_name": "MetroError", + "description": "MetroError Error with details", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CorrelationId": { + "name": "CorrelationId", + "description": "", + "json_tag": "correlationId" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "ErrorCode": { + "name": "ErrorCode", + "description": "", + "json_tag": "errorCode" + }, + "ErrorMessage": { + "name": "ErrorMessage", + "description": "", + "json_tag": "errorMessage" + }, + "Help": { + "name": "Help", + "description": "", + "json_tag": "help" + } + } + }, + "MetroResponse": { + "type_name": "MetroResponse", + "description": "MetroResponse GET Metros retrieves all Equinix® Fabric™ metros, as well as latency data for each location.This performance data helps network planning engineers and administrators make strategic decisions about port locations and traffic routes.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of Fabric Metros.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "Network": { + "type_name": "Network", + "description": "Network Network specification", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "ConnectionsCount": { + "name": "ConnectionsCount", + "description": "number of connections created on the network", + "json_tag": "connectionsCount" + }, + "Href": { + "name": "Href", + "description": "Network URI", + "json_tag": "href" + }, + "Links": { + "name": "Links", + "description": "Network sub-resources links", + "json_tag": "links" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Name": { + "name": "Name", + "description": "Customer-provided network name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Preferences for notifications on network configuration or status changes", + "json_tag": "notifications" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Scope": { + "name": "Scope", + "description": "", + "json_tag": "scope" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned network identifier", + "json_tag": "uuid" + } + } + }, + "NetworkChange": { + "type_name": "NetworkChange", + "description": "NetworkChange Current state of latest network change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Set when change flow starts", + "json_tag": "createdDateTime" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Href": { + "name": "Href", + "description": "Network URI", + "json_tag": "href" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "Set when change object is updated", + "json_tag": "updatedDateTime" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "NetworkChangeOperation": { + "type_name": "NetworkChangeOperation", + "description": "NetworkChangeOperation Network change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path inside document leading to updated parameter", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "new value for updated parameter", + "json_tag": "value" + } + } + }, + "NetworkChangeResponse": { + "type_name": "NetworkChangeResponse", + "description": "NetworkChangeResponse List of network changes", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "NetworkConnections": { + "type_name": "NetworkConnections", + "description": "NetworkConnections List of network changes", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "NetworkFilter": { + "type_name": "NetworkFilter", + "description": "NetworkFilter struct for NetworkFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + }, + "Operator": { + "name": "Operator", + "description": "", + "json_tag": "operator" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "NetworkOperation": { + "type_name": "NetworkOperation", + "description": "NetworkOperation Network operational data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "EquinixStatus": { + "name": "EquinixStatus", + "description": "", + "json_tag": "equinixStatus" + } + } + }, + "NetworkPostRequest": { + "type_name": "NetworkPostRequest", + "description": "NetworkPostRequest Create Network", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Name": { + "name": "Name", + "description": "Customer-provided network name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Preferences for notifications on network configuration or status changes", + "json_tag": "notifications" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Scope": { + "name": "Scope", + "description": "", + "json_tag": "scope" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "NetworkSearchRequest": { + "type_name": "NetworkSearchRequest", + "description": "NetworkSearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "NetworkSearchResponse": { + "type_name": "NetworkSearchResponse", + "description": "NetworkSearchResponse List of networks", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "NetworkSortCriteria": { + "type_name": "NetworkSortCriteria", + "description": "NetworkSortCriteria struct for NetworkSortCriteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "NetworkSortCriteriaResponse": { + "type_name": "NetworkSortCriteriaResponse", + "description": "NetworkSortCriteriaResponse struct for NetworkSortCriteriaResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "NullableAWSDirectConnect": { + "type_name": "NullableAWSDirectConnect", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSDirectConnectResponse": { + "type_name": "NullableAWSDirectConnectResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSPermission": { + "type_name": "NullableAWSPermission", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSPermissionType": { + "type_name": "NullableAWSPermissionType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSProvider": { + "type_name": "NullableAWSProvider", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSProviderResource": { + "type_name": "NullableAWSProviderResource", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSProviderResourceResponse": { + "type_name": "NullableAWSProviderResourceResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSProviderResponse": { + "type_name": "NullableAWSProviderResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSProviderType": { + "type_name": "NullableAWSProviderType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSVirtualPrivateGateway": { + "type_name": "NullableAWSVirtualPrivateGateway", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSVirtualPrivateGatewayResponse": { + "type_name": "NullableAWSVirtualPrivateGatewayResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSVirtualPrivateGatewayType": { + "type_name": "NullableAWSVirtualPrivateGatewayType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAccessPoint": { + "type_name": "NullableAccessPoint", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAccessPointRole": { + "type_name": "NullableAccessPointRole", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAccessPointSelector": { + "type_name": "NullableAccessPointSelector", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAccessPointSelectorType": { + "type_name": "NullableAccessPointSelectorType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAccessPointType": { + "type_name": "NullableAccessPointType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableActionRequest": { + "type_name": "NullableActionRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableActions": { + "type_name": "NullableActions", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAddOperation": { + "type_name": "NullableAddOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAlertRulePostRequest": { + "type_name": "NullableAlertRulePostRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAlertRulePostRequestType": { + "type_name": "NullableAlertRulePostRequestType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAlertRulePutRequest": { + "type_name": "NullableAlertRulePutRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAllPhysicalPortsResponse": { + "type_name": "NullableAllPhysicalPortsResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAllPortPackagesResponse": { + "type_name": "NullableAllPortPackagesResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAllPortsResponse": { + "type_name": "NullableAllPortsResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableApiConfig": { + "type_name": "NullableApiConfig", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableApiServices": { + "type_name": "NullableApiServices", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAsset": { + "type_name": "NullableAsset", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAuthContext": { + "type_name": "NullableAuthContext", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAuthContextAuthid": { + "type_name": "NullableAuthContextAuthid", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAuthContextAuthtype": { + "type_name": "NullableAuthContextAuthtype", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAuthenticationKey": { + "type_name": "NullableAuthenticationKey", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBGPActionData": { + "type_name": "NullableBGPActionData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBGPActionRequest": { + "type_name": "NullableBGPActionRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBGPActionStates": { + "type_name": "NullableBGPActionStates", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBGPActions": { + "type_name": "NullableBGPActions", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBGPActionsBulkData": { + "type_name": "NullableBGPActionsBulkData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBGPConnectionIpv4": { + "type_name": "NullableBGPConnectionIpv4", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBGPConnectionIpv6": { + "type_name": "NullableBGPConnectionIpv6", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBGPConnectionOperation": { + "type_name": "NullableBGPConnectionOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBGPConnectionOperationOperationalStatus": { + "type_name": "NullableBGPConnectionOperationOperationalStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBandwidthUtilization": { + "type_name": "NullableBandwidthUtilization", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBandwidthUtilizationUnit": { + "type_name": "NullableBandwidthUtilizationUnit", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBool": { + "type_name": "NullableBool", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBulkPhysicalPort": { + "type_name": "NullableBulkPhysicalPort", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBulkPortRequest": { + "type_name": "NullableBulkPortRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableChange": { + "type_name": "NullableChange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableChangeStatus": { + "type_name": "NullableChangeStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableChangeType": { + "type_name": "NullableChangeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableChangelog": { + "type_name": "NullableChangelog", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudEvent": { + "type_name": "NullableCloudEvent", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudEventAssetType": { + "type_name": "NullableCloudEventAssetType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudEventData": { + "type_name": "NullableCloudEventData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudEventFilters": { + "type_name": "NullableCloudEventFilters", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudEventSearchRequest": { + "type_name": "NullableCloudEventSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudEventSimpleExpression": { + "type_name": "NullableCloudEventSimpleExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouter": { + "type_name": "NullableCloudRouter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterAccessPointState": { + "type_name": "NullableCloudRouterAccessPointState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionRequest": { + "type_name": "NullableCloudRouterActionRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionResponse": { + "type_name": "NullableCloudRouterActionResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionState": { + "type_name": "NullableCloudRouterActionState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionType": { + "type_name": "NullableCloudRouterActionType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionsSearchExpression": { + "type_name": "NullableCloudRouterActionsSearchExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionsSearchFilter": { + "type_name": "NullableCloudRouterActionsSearchFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionsSearchFilters": { + "type_name": "NullableCloudRouterActionsSearchFilters", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionsSearchOrFilter": { + "type_name": "NullableCloudRouterActionsSearchOrFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionsSearchRequest": { + "type_name": "NullableCloudRouterActionsSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionsSearchResponse": { + "type_name": "NullableCloudRouterActionsSearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionsSearchSortBy": { + "type_name": "NullableCloudRouterActionsSearchSortBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionsSearchSortCriteria": { + "type_name": "NullableCloudRouterActionsSearchSortCriteria", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterActionsSearchSortDirection": { + "type_name": "NullableCloudRouterActionsSearchSortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterChange": { + "type_name": "NullableCloudRouterChange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterChangeOperation": { + "type_name": "NullableCloudRouterChangeOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterChangeType": { + "type_name": "NullableCloudRouterChangeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommand": { + "type_name": "NullableCloudRouterCommand", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandPingResponse": { + "type_name": "NullableCloudRouterCommandPingResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandPostRequest": { + "type_name": "NullableCloudRouterCommandPostRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandRequestConnection": { + "type_name": "NullableCloudRouterCommandRequestConnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandRequestPayload": { + "type_name": "NullableCloudRouterCommandRequestPayload", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandRequestResponse": { + "type_name": "NullableCloudRouterCommandRequestResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandResponse": { + "type_name": "NullableCloudRouterCommandResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandSearchExpression": { + "type_name": "NullableCloudRouterCommandSearchExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandSearchFilter": { + "type_name": "NullableCloudRouterCommandSearchFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandSearchFilters": { + "type_name": "NullableCloudRouterCommandSearchFilters", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandSearchOrFilter": { + "type_name": "NullableCloudRouterCommandSearchOrFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandSearchRequest": { + "type_name": "NullableCloudRouterCommandSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandSearchResponse": { + "type_name": "NullableCloudRouterCommandSearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandSearchSortBy": { + "type_name": "NullableCloudRouterCommandSearchSortBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandSearchSortCriteria": { + "type_name": "NullableCloudRouterCommandSearchSortCriteria", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandSearchSortDirection": { + "type_name": "NullableCloudRouterCommandSearchSortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandState": { + "type_name": "NullableCloudRouterCommandState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandTracerouteResponse": { + "type_name": "NullableCloudRouterCommandTracerouteResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterCommandType": { + "type_name": "NullableCloudRouterCommandType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterFilter": { + "type_name": "NullableCloudRouterFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterFilters": { + "type_name": "NullableCloudRouterFilters", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterForGatewayAttachmentResponse": { + "type_name": "NullableCloudRouterForGatewayAttachmentResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterListForGatewayAttachment": { + "type_name": "NullableCloudRouterListForGatewayAttachment", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterOrFilter": { + "type_name": "NullableCloudRouterOrFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterPackage": { + "type_name": "NullableCloudRouterPackage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterPackageType": { + "type_name": "NullableCloudRouterPackageType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterPostRequest": { + "type_name": "NullableCloudRouterPostRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterPostRequestBase": { + "type_name": "NullableCloudRouterPostRequestBase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterPostRequestBaseType": { + "type_name": "NullableCloudRouterPostRequestBaseType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterPostRequestPackage": { + "type_name": "NullableCloudRouterPostRequestPackage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterPostRequestPackageCode": { + "type_name": "NullableCloudRouterPostRequestPackageCode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterPostRequestPackageType": { + "type_name": "NullableCloudRouterPostRequestPackageType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterSearchRequest": { + "type_name": "NullableCloudRouterSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterSimpleExpression": { + "type_name": "NullableCloudRouterSimpleExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterSortBy": { + "type_name": "NullableCloudRouterSortBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterSortCriteria": { + "type_name": "NullableCloudRouterSortCriteria", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCloudRouterSortDirection": { + "type_name": "NullableCloudRouterSortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCode": { + "type_name": "NullableCode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectedMetro": { + "type_name": "NullableConnectedMetro", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnection": { + "type_name": "NullableConnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionAcceptanceData": { + "type_name": "NullableConnectionAcceptanceData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionAction": { + "type_name": "NullableConnectionAction", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionActionRequest": { + "type_name": "NullableConnectionActionRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionChangeOperation": { + "type_name": "NullableConnectionChangeOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionCompanyProfile": { + "type_name": "NullableConnectionCompanyProfile", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionDirection": { + "type_name": "NullableConnectionDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionInvitation": { + "type_name": "NullableConnectionInvitation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionLink": { + "type_name": "NullableConnectionLink", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionLinkType": { + "type_name": "NullableConnectionLinkType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionOperation": { + "type_name": "NullableConnectionOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionOperationOperationalStatus": { + "type_name": "NullableConnectionOperationOperationalStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionPostRequest": { + "type_name": "NullableConnectionPostRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionPriority": { + "type_name": "NullableConnectionPriority", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRedundancy": { + "type_name": "NullableConnectionRedundancy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionResponse": { + "type_name": "NullableConnectionResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteAggregationData": { + "type_name": "NullableConnectionRouteAggregationData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteAggregationDataAttachmentStatus": { + "type_name": "NullableConnectionRouteAggregationDataAttachmentStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteAggregationDataType": { + "type_name": "NullableConnectionRouteAggregationDataType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteEntryFilter": { + "type_name": "NullableConnectionRouteEntryFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteEntryFilters": { + "type_name": "NullableConnectionRouteEntryFilters", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteEntryOrFilter": { + "type_name": "NullableConnectionRouteEntryOrFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteEntrySimpleExpression": { + "type_name": "NullableConnectionRouteEntrySimpleExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteEntrySortBy": { + "type_name": "NullableConnectionRouteEntrySortBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteEntrySortDirection": { + "type_name": "NullableConnectionRouteEntrySortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteFilterData": { + "type_name": "NullableConnectionRouteFilterData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteFilterDataDirection": { + "type_name": "NullableConnectionRouteFilterDataDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteFilterDataType": { + "type_name": "NullableConnectionRouteFilterDataType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteFiltersBase": { + "type_name": "NullableConnectionRouteFiltersBase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteFiltersBaseDirection": { + "type_name": "NullableConnectionRouteFiltersBaseDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteSearchRequest": { + "type_name": "NullableConnectionRouteSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteSortCriteria": { + "type_name": "NullableConnectionRouteSortCriteria", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteTableEntry": { + "type_name": "NullableConnectionRouteTableEntry", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteTableEntryConnection": { + "type_name": "NullableConnectionRouteTableEntryConnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteTableEntrySearchResponse": { + "type_name": "NullableConnectionRouteTableEntrySearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRouteTableEntryState": { + "type_name": "NullableConnectionRouteTableEntryState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionRoutingProtocolPostRequest": { + "type_name": "NullableConnectionRoutingProtocolPostRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionSearchResponse": { + "type_name": "NullableConnectionSearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionSide": { + "type_name": "NullableConnectionSide", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionSideAdditionalInfo": { + "type_name": "NullableConnectionSideAdditionalInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionState": { + "type_name": "NullableConnectionState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionType": { + "type_name": "NullableConnectionType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectivitySource": { + "type_name": "NullableConnectivitySource", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectivitySourceType": { + "type_name": "NullableConnectivitySourceType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCustomField": { + "type_name": "NullableCustomField", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCustomFieldDataType": { + "type_name": "NullableCustomFieldDataType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeploymentState": { + "type_name": "NullableDeploymentState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeploymentTopology": { + "type_name": "NullableDeploymentTopology", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDetectionMethod": { + "type_name": "NullableDetectionMethod", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDetectionMethodOperand": { + "type_name": "NullableDetectionMethodOperand", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDetectionMethodResponse": { + "type_name": "NullableDetectionMethodResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDetectionMethodType": { + "type_name": "NullableDetectionMethodType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDirectConnectionIpv4": { + "type_name": "NullableDirectConnectionIpv4", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDirectConnectionIpv6": { + "type_name": "NullableDirectConnectionIpv6", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDirection": { + "type_name": "NullableDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableEndCustomer": { + "type_name": "NullableEndCustomer", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableEquinixStatus": { + "type_name": "NullableEquinixStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableError": { + "type_name": "NullableError", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableExpression": { + "type_name": "NullableExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableExpressionOperator": { + "type_name": "NullableExpressionOperator", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricBGPConnectionIpv4": { + "type_name": "NullableFabricBGPConnectionIpv4", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricCloudRouterCode": { + "type_name": "NullableFabricCloudRouterCode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricCloudRouterPackages": { + "type_name": "NullableFabricCloudRouterPackages", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricCloudRouterPrice": { + "type_name": "NullableFabricCloudRouterPrice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricConnection": { + "type_name": "NullableFabricConnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricConnectionResponse": { + "type_name": "NullableFabricConnectionResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricConnectionType": { + "type_name": "NullableFabricConnectionType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricIPWAN": { + "type_name": "NullableFabricIPWAN", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricIPWANConnection": { + "type_name": "NullableFabricIPWANConnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricIPWANConnectionResponse": { + "type_name": "NullableFabricIPWANConnectionResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricIPWANResponse": { + "type_name": "NullableFabricIPWANResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricProvider": { + "type_name": "NullableFabricProvider", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricProviderResource": { + "type_name": "NullableFabricProviderResource", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricProviderResourceResponse": { + "type_name": "NullableFabricProviderResourceResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricProviderResponse": { + "type_name": "NullableFabricProviderResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricProviderType": { + "type_name": "NullableFabricProviderType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricRouteProtocols": { + "type_name": "NullableFabricRouteProtocols", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricRouteProtocolsResponse": { + "type_name": "NullableFabricRouteProtocolsResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricRouter": { + "type_name": "NullableFabricRouter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricRouterResponse": { + "type_name": "NullableFabricRouterResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricRouterType": { + "type_name": "NullableFabricRouterType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricRoutingProtocolBGPType": { + "type_name": "NullableFabricRoutingProtocolBGPType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFilterBody": { + "type_name": "NullableFilterBody", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat32": { + "type_name": "NullableFloat32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat64": { + "type_name": "NullableFloat64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGCPCloudRouter": { + "type_name": "NullableGCPCloudRouter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGCPCloudRouterResponse": { + "type_name": "NullableGCPCloudRouterResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGCPCloudRouterType": { + "type_name": "NullableGCPCloudRouterType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGCPPermission": { + "type_name": "NullableGCPPermission", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGCPProvider": { + "type_name": "NullableGCPProvider", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGCPProviderResource": { + "type_name": "NullableGCPProviderResource", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGCPProviderResourceResponse": { + "type_name": "NullableGCPProviderResourceResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGCPProviderResponse": { + "type_name": "NullableGCPProviderResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGCPProviderType": { + "type_name": "NullableGCPProviderType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGatewayAttachmentListResponse": { + "type_name": "NullableGatewayAttachmentListResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGatewayAttachmentResponse": { + "type_name": "NullableGatewayAttachmentResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGatewayAttachmentResponseAttachmentStatus": { + "type_name": "NullableGatewayAttachmentResponseAttachmentStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGatewayAttachmentResponseType": { + "type_name": "NullableGatewayAttachmentResponseType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGeoCoordinates": { + "type_name": "NullableGeoCoordinates", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGeoScopeType": { + "type_name": "NullableGeoScopeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetAllCloudRouterCommands": { + "type_name": "NullableGetAllCloudRouterCommands", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetAllConnectionRouteAggregationsResponse": { + "type_name": "NullableGetAllConnectionRouteAggregationsResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetAllConnectionRouteFiltersResponse": { + "type_name": "NullableGetAllConnectionRouteFiltersResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetAllStreamAlertRuleResponse": { + "type_name": "NullableGetAllStreamAlertRuleResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetAllStreamAssetResponse": { + "type_name": "NullableGetAllStreamAssetResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetAllStreamResponse": { + "type_name": "NullableGetAllStreamResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetAllStreamSubscriptionResponse": { + "type_name": "NullableGetAllStreamSubscriptionResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetCloudEventsByAssetResponse": { + "type_name": "NullableGetCloudEventsByAssetResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetMetricsByAssetResponse": { + "type_name": "NullableGetMetricsByAssetResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetResponse": { + "type_name": "NullableGetResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetRouteAggregationGetConnectionsResponse": { + "type_name": "NullableGetRouteAggregationGetConnectionsResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetRouteAggregationRulesResponse": { + "type_name": "NullableGetRouteAggregationRulesResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetRouteFilterGetConnectionsResponse": { + "type_name": "NullableGetRouteFilterGetConnectionsResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetRouteFilterRulesResponse": { + "type_name": "NullableGetRouteFilterRulesResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetServiceProfilesViewPointParameter": { + "type_name": "NullableGetServiceProfilesViewPointParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetTimeServicesPackageByCodePackageCodeParameter": { + "type_name": "NullableGetTimeServicesPackageByCodePackageCodeParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableHealthResponse": { + "type_name": "NullableHealthResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableHop": { + "type_name": "NullableHop", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableHopProbes": { + "type_name": "NullableHopProbes", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt": { + "type_name": "NullableInt", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt32": { + "type_name": "NullableInt32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt64": { + "type_name": "NullableInt64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterface": { + "type_name": "NullableInterface", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterfaceType": { + "type_name": "NullableInterfaceType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInternetAccess": { + "type_name": "NullableInternetAccess", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpBlockPrice": { + "type_name": "NullableIpBlockPrice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpBlockType": { + "type_name": "NullableIpBlockType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIpv4": { + "type_name": "NullableIpv4", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableJsonPatchOperation": { + "type_name": "NullableJsonPatchOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLink": { + "type_name": "NullableLink", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLinkAggregationGroup": { + "type_name": "NullableLinkAggregationGroup", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLinkProtocolConnection": { + "type_name": "NullableLinkProtocolConnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLinkProtocolGetResponse": { + "type_name": "NullableLinkProtocolGetResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLinkProtocolRequestType": { + "type_name": "NullableLinkProtocolRequestType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLinkProtocolResponse": { + "type_name": "NullableLinkProtocolResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLinkProtocolServiceToken": { + "type_name": "NullableLinkProtocolServiceToken", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLinkProtocolState": { + "type_name": "NullableLinkProtocolState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLinkProtocolType": { + "type_name": "NullableLinkProtocolType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMarketingInfo": { + "type_name": "NullableMarketingInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMarketplaceSubscription": { + "type_name": "NullableMarketplaceSubscription", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMarketplaceSubscriptionType": { + "type_name": "NullableMarketplaceSubscriptionType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMd5": { + "type_name": "NullableMd5", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMd5Type": { + "type_name": "NullableMd5Type", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetalInterconnection": { + "type_name": "NullableMetalInterconnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetric": { + "type_name": "NullableMetric", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetricAssetType": { + "type_name": "NullableMetricAssetType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetricDatapoints": { + "type_name": "NullableMetricDatapoints", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetricFilters": { + "type_name": "NullableMetricFilters", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetricResource": { + "type_name": "NullableMetricResource", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetricSelector": { + "type_name": "NullableMetricSelector", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetricSelectorResponse": { + "type_name": "NullableMetricSelectorResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetricSimpleExpression": { + "type_name": "NullableMetricSimpleExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetrics": { + "type_name": "NullableMetrics", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetricsSearchRequest": { + "type_name": "NullableMetricsSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetro": { + "type_name": "NullableMetro", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetroError": { + "type_name": "NullableMetroError", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetroErrorErrorCode": { + "type_name": "NullableMetroErrorErrorCode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetroErrorErrorMessage": { + "type_name": "NullableMetroErrorErrorMessage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetroResponse": { + "type_name": "NullableMetroResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetwork": { + "type_name": "NullableNetwork", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkChange": { + "type_name": "NullableNetworkChange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkChangeOperation": { + "type_name": "NullableNetworkChangeOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkChangeResponse": { + "type_name": "NullableNetworkChangeResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkChangeStatus": { + "type_name": "NullableNetworkChangeStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkChangeType": { + "type_name": "NullableNetworkChangeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkConnections": { + "type_name": "NullableNetworkConnections", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkEquinixStatus": { + "type_name": "NullableNetworkEquinixStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkFilter": { + "type_name": "NullableNetworkFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkFilterOperator": { + "type_name": "NullableNetworkFilterOperator", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkOperation": { + "type_name": "NullableNetworkOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkPostRequest": { + "type_name": "NullableNetworkPostRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkScope": { + "type_name": "NullableNetworkScope", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkSearchFieldName": { + "type_name": "NullableNetworkSearchFieldName", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkSearchRequest": { + "type_name": "NullableNetworkSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkSearchResponse": { + "type_name": "NullableNetworkSearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkSortBy": { + "type_name": "NullableNetworkSortBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkSortByResponse": { + "type_name": "NullableNetworkSortByResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkSortCriteria": { + "type_name": "NullableNetworkSortCriteria", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkSortCriteriaResponse": { + "type_name": "NullableNetworkSortCriteriaResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkSortDirection": { + "type_name": "NullableNetworkSortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkSortDirectionResponse": { + "type_name": "NullableNetworkSortDirectionResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkState": { + "type_name": "NullableNetworkState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNetworkType": { + "type_name": "NullableNetworkType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOpEnum": { + "type_name": "NullableOpEnum", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOperation": { + "type_name": "NullableOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOperationalStatus": { + "type_name": "NullableOperationalStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrchestratorProviders": { + "type_name": "NullableOrchestratorProviders", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrder": { + "type_name": "NullableOrder", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOutputStructuredPing": { + "type_name": "NullableOutputStructuredPing", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOutputStructuredPingResponseItem": { + "type_name": "NullableOutputStructuredPingResponseItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOutputStructuredTraceroute": { + "type_name": "NullableOutputStructuredTraceroute", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePackage": { + "type_name": "NullablePackage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePackageChangeLog": { + "type_name": "NullablePackageChangeLog", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePackageCode": { + "type_name": "NullablePackageCode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePackageResponse": { + "type_name": "NullablePackageResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePackageType": { + "type_name": "NullablePackageType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePagination": { + "type_name": "NullablePagination", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePaginationRequest": { + "type_name": "NullablePaginationRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePeeringType": { + "type_name": "NullablePeeringType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePhysicalPort": { + "type_name": "NullablePhysicalPort", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePhysicalPortSettings": { + "type_name": "NullablePhysicalPortSettings", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePhysicalPortType": { + "type_name": "NullablePhysicalPortType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePort": { + "type_name": "NullablePort", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortAdditionalInfo": { + "type_name": "NullablePortAdditionalInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortBmmrType": { + "type_name": "NullablePortBmmrType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortChange": { + "type_name": "NullablePortChange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortChangeOperation": { + "type_name": "NullablePortChangeOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortChangeStatus": { + "type_name": "NullablePortChangeStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortChangeType": { + "type_name": "NullablePortChangeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortConnectivitySourceType": { + "type_name": "NullablePortConnectivitySourceType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortDemarcationPoint": { + "type_name": "NullablePortDemarcationPoint", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortDevice": { + "type_name": "NullablePortDevice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortDeviceRedundancy": { + "type_name": "NullablePortDeviceRedundancy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortDeviceRedundancyPriority": { + "type_name": "NullablePortDeviceRedundancyPriority", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortEncapsulation": { + "type_name": "NullablePortEncapsulation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortEncapsulationType": { + "type_name": "NullablePortEncapsulationType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortExpression": { + "type_name": "NullablePortExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortInterface": { + "type_name": "NullablePortInterface", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortLag": { + "type_name": "NullablePortLag", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortLoa": { + "type_name": "NullablePortLoa", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortNotification": { + "type_name": "NullablePortNotification", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortNotificationType": { + "type_name": "NullablePortNotificationType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortOperation": { + "type_name": "NullablePortOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortOperationOperationalStatus": { + "type_name": "NullablePortOperationOperationalStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortOrder": { + "type_name": "NullablePortOrder", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortOrderPurchaseOrder": { + "type_name": "NullablePortOrderPurchaseOrder", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortOrderPurchaseOrderSelectionType": { + "type_name": "NullablePortOrderPurchaseOrderSelectionType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortOrderPurchaseOrderType": { + "type_name": "NullablePortOrderPurchaseOrderType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortOrderSignature": { + "type_name": "NullablePortOrderSignature", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortOrderSignatureDelegate": { + "type_name": "NullablePortOrderSignatureDelegate", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortOrderSignatureSignatory": { + "type_name": "NullablePortOrderSignatureSignatory", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortPackage": { + "type_name": "NullablePortPackage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortPackageSourceType": { + "type_name": "NullablePortPackageSourceType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortPackageSupportedServiceTypesInner": { + "type_name": "NullablePortPackageSupportedServiceTypesInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortPackageType": { + "type_name": "NullablePortPackageType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortPhysicalPortsType": { + "type_name": "NullablePortPhysicalPortsType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortPriority": { + "type_name": "NullablePortPriority", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortRedundancy": { + "type_name": "NullablePortRedundancy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortRequest": { + "type_name": "NullablePortRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortSearchFieldName": { + "type_name": "NullablePortSearchFieldName", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortServiceType": { + "type_name": "NullablePortServiceType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortSettings": { + "type_name": "NullablePortSettings", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortSettingsPackageType": { + "type_name": "NullablePortSettingsPackageType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortSettingsSharedPortProduct": { + "type_name": "NullablePortSettingsSharedPortProduct", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortSortBy": { + "type_name": "NullablePortSortBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortSortCriteria": { + "type_name": "NullablePortSortCriteria", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortSortDirection": { + "type_name": "NullablePortSortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortState": { + "type_name": "NullablePortState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortTether": { + "type_name": "NullablePortTether", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortType": { + "type_name": "NullablePortType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortV4SearchRequest": { + "type_name": "NullablePortV4SearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimeChangeOperation": { + "type_name": "NullablePrecisionTimeChangeOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimeChangeOperationOp": { + "type_name": "NullablePrecisionTimeChangeOperationOp", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimeChangeOperationPath": { + "type_name": "NullablePrecisionTimeChangeOperationPath", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimeOrder": { + "type_name": "NullablePrecisionTimeOrder", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimePackagePostResponse": { + "type_name": "NullablePrecisionTimePackagePostResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimePackageRequest": { + "type_name": "NullablePrecisionTimePackageRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimePackageRequestCode": { + "type_name": "NullablePrecisionTimePackageRequestCode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimePackageResponse": { + "type_name": "NullablePrecisionTimePackageResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimePackageResponseType": { + "type_name": "NullablePrecisionTimePackageResponseType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimePrice": { + "type_name": "NullablePrecisionTimePrice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimeServiceConnectionsResponse": { + "type_name": "NullablePrecisionTimeServiceConnectionsResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimeServicePackagesResponse": { + "type_name": "NullablePrecisionTimeServicePackagesResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimeServiceRequest": { + "type_name": "NullablePrecisionTimeServiceRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimeServiceRequestType": { + "type_name": "NullablePrecisionTimeServiceRequestType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimeServiceResponse": { + "type_name": "NullablePrecisionTimeServiceResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimeServiceResponseState": { + "type_name": "NullablePrecisionTimeServiceResponseState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrecisionTimeServiceResponseType": { + "type_name": "NullablePrecisionTimeServiceResponseType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePresence": { + "type_name": "NullablePresence", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrice": { + "type_name": "NullablePrice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePriceCategory": { + "type_name": "NullablePriceCategory", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePriceCharge": { + "type_name": "NullablePriceCharge", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePriceChargeType": { + "type_name": "NullablePriceChargeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePriceError": { + "type_name": "NullablePriceError", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePriceErrorAdditionalInfo": { + "type_name": "NullablePriceErrorAdditionalInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePriceErrorErrorCode": { + "type_name": "NullablePriceErrorErrorCode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePriceErrorErrorMessage": { + "type_name": "NullablePriceErrorErrorMessage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePriceLocation": { + "type_name": "NullablePriceLocation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePriceSearchResponse": { + "type_name": "NullablePriceSearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePriceTermLength": { + "type_name": "NullablePriceTermLength", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProcessStep": { + "type_name": "NullableProcessStep", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProductType": { + "type_name": "NullableProductType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProject": { + "type_name": "NullableProject", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProviderResponse": { + "type_name": "NullableProviderResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProviderStatus": { + "type_name": "NullableProviderStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProviderType": { + "type_name": "NullableProviderType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProvidersSearchResponse": { + "type_name": "NullableProvidersSearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePtpAdvanceConfiguration": { + "type_name": "NullablePtpAdvanceConfiguration", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePtpAdvanceConfigurationLogAnnounceInterval": { + "type_name": "NullablePtpAdvanceConfigurationLogAnnounceInterval", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePtpAdvanceConfigurationLogDelayReqInterval": { + "type_name": "NullablePtpAdvanceConfigurationLogDelayReqInterval", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePtpAdvanceConfigurationLogSyncInterval": { + "type_name": "NullablePtpAdvanceConfigurationLogSyncInterval", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePtpAdvanceConfigurationTimeScale": { + "type_name": "NullablePtpAdvanceConfigurationTimeScale", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePtpAdvanceConfigurationTransportMode": { + "type_name": "NullablePtpAdvanceConfigurationTransportMode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRemoveOperation": { + "type_name": "NullableRemoveOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableReplaceOperation": { + "type_name": "NullableReplaceOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableResourceData": { + "type_name": "NullableResourceData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableResourceSelector": { + "type_name": "NullableResourceSelector", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableResourceSelectorResponse": { + "type_name": "NullableResourceSelectorResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationChangeData": { + "type_name": "NullableRouteAggregationChangeData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationChangeDataResponse": { + "type_name": "NullableRouteAggregationChangeDataResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationConnectionsData": { + "type_name": "NullableRouteAggregationConnectionsData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationRuleState": { + "type_name": "NullableRouteAggregationRuleState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationRulesBase": { + "type_name": "NullableRouteAggregationRulesBase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationRulesChange": { + "type_name": "NullableRouteAggregationRulesChange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationRulesChangeData": { + "type_name": "NullableRouteAggregationRulesChangeData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationRulesChangeDataResponse": { + "type_name": "NullableRouteAggregationRulesChangeDataResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationRulesChangeOperation": { + "type_name": "NullableRouteAggregationRulesChangeOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationRulesChangeType": { + "type_name": "NullableRouteAggregationRulesChangeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationRulesData": { + "type_name": "NullableRouteAggregationRulesData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationRulesDataType": { + "type_name": "NullableRouteAggregationRulesDataType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationRulesPatchRequestItem": { + "type_name": "NullableRouteAggregationRulesPatchRequestItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationRulesPostRequest": { + "type_name": "NullableRouteAggregationRulesPostRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationSortItem": { + "type_name": "NullableRouteAggregationSortItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationSortItemProperty": { + "type_name": "NullableRouteAggregationSortItemProperty", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationState": { + "type_name": "NullableRouteAggregationState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsBase": { + "type_name": "NullableRouteAggregationsBase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsBaseType": { + "type_name": "NullableRouteAggregationsBaseType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsChange": { + "type_name": "NullableRouteAggregationsChange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsChangeOperation": { + "type_name": "NullableRouteAggregationsChangeOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsChangeType": { + "type_name": "NullableRouteAggregationsChangeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsData": { + "type_name": "NullableRouteAggregationsData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsDataProject": { + "type_name": "NullableRouteAggregationsDataProject", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsPatchRequestItem": { + "type_name": "NullableRouteAggregationsPatchRequestItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsSearchBase": { + "type_name": "NullableRouteAggregationsSearchBase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsSearchBaseFilter": { + "type_name": "NullableRouteAggregationsSearchBaseFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsSearchFilterItem": { + "type_name": "NullableRouteAggregationsSearchFilterItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteAggregationsSearchResponse": { + "type_name": "NullableRouteAggregationsSearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterChangeData": { + "type_name": "NullableRouteFilterChangeData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterChangeDataResponse": { + "type_name": "NullableRouteFilterChangeDataResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterConnectionsData": { + "type_name": "NullableRouteFilterConnectionsData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRuleState": { + "type_name": "NullableRouteFilterRuleState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRulesBase": { + "type_name": "NullableRouteFilterRulesBase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRulesChange": { + "type_name": "NullableRouteFilterRulesChange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRulesChangeData": { + "type_name": "NullableRouteFilterRulesChangeData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRulesChangeDataResponse": { + "type_name": "NullableRouteFilterRulesChangeDataResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRulesChangeOperation": { + "type_name": "NullableRouteFilterRulesChangeOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRulesChangeType": { + "type_name": "NullableRouteFilterRulesChangeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRulesData": { + "type_name": "NullableRouteFilterRulesData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRulesDataAction": { + "type_name": "NullableRouteFilterRulesDataAction", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRulesDataType": { + "type_name": "NullableRouteFilterRulesDataType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRulesPatchRequestItem": { + "type_name": "NullableRouteFilterRulesPatchRequestItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterRulesPostRequest": { + "type_name": "NullableRouteFilterRulesPostRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFilterState": { + "type_name": "NullableRouteFilterState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersBase": { + "type_name": "NullableRouteFiltersBase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersBaseType": { + "type_name": "NullableRouteFiltersBaseType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersChange": { + "type_name": "NullableRouteFiltersChange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersChangeOperation": { + "type_name": "NullableRouteFiltersChangeOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersChangeType": { + "type_name": "NullableRouteFiltersChangeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersData": { + "type_name": "NullableRouteFiltersData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersDataNotMatchedRuleAction": { + "type_name": "NullableRouteFiltersDataNotMatchedRuleAction", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersDataProject": { + "type_name": "NullableRouteFiltersDataProject", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersPatchRequestItem": { + "type_name": "NullableRouteFiltersPatchRequestItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersSearchBase": { + "type_name": "NullableRouteFiltersSearchBase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersSearchBaseFilter": { + "type_name": "NullableRouteFiltersSearchBaseFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersSearchFilterItem": { + "type_name": "NullableRouteFiltersSearchFilterItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersSearchFilterItemProperty": { + "type_name": "NullableRouteFiltersSearchFilterItemProperty", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteFiltersSearchResponse": { + "type_name": "NullableRouteFiltersSearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntry": { + "type_name": "NullableRouteTableEntry", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntryConnection": { + "type_name": "NullableRouteTableEntryConnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntryFilter": { + "type_name": "NullableRouteTableEntryFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntryFilters": { + "type_name": "NullableRouteTableEntryFilters", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntryOrFilter": { + "type_name": "NullableRouteTableEntryOrFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntryProtocolType": { + "type_name": "NullableRouteTableEntryProtocolType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntrySearchRequest": { + "type_name": "NullableRouteTableEntrySearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntrySearchResponse": { + "type_name": "NullableRouteTableEntrySearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntrySimpleExpression": { + "type_name": "NullableRouteTableEntrySimpleExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntrySortBy": { + "type_name": "NullableRouteTableEntrySortBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntrySortCriteria": { + "type_name": "NullableRouteTableEntrySortCriteria", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntrySortDirection": { + "type_name": "NullableRouteTableEntrySortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntryState": { + "type_name": "NullableRouteTableEntryState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouteTableEntryType": { + "type_name": "NullableRouteTableEntryType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouterActionsConnection": { + "type_name": "NullableRouterActionsConnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouterActionsRouter": { + "type_name": "NullableRouterActionsRouter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRouterPackageCode": { + "type_name": "NullableRouterPackageCode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolBFD": { + "type_name": "NullableRoutingProtocolBFD", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolBGPData": { + "type_name": "NullableRoutingProtocolBGPData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolBGPDataState": { + "type_name": "NullableRoutingProtocolBGPDataState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolBGPType": { + "type_name": "NullableRoutingProtocolBGPType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolBGPTypeType": { + "type_name": "NullableRoutingProtocolBGPTypeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolBase": { + "type_name": "NullableRoutingProtocolBase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolChange": { + "type_name": "NullableRoutingProtocolChange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolChangeData": { + "type_name": "NullableRoutingProtocolChangeData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolChangeDataResponse": { + "type_name": "NullableRoutingProtocolChangeDataResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolChangeOperation": { + "type_name": "NullableRoutingProtocolChangeOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolChangeOperationOp": { + "type_name": "NullableRoutingProtocolChangeOperationOp", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolChangeType": { + "type_name": "NullableRoutingProtocolChangeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolData": { + "type_name": "NullableRoutingProtocolData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolDirectData": { + "type_name": "NullableRoutingProtocolDirectData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolDirectType": { + "type_name": "NullableRoutingProtocolDirectType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolDirectTypeType": { + "type_name": "NullableRoutingProtocolDirectTypeType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRoutingProtocolOperation": { + "type_name": "NullableRoutingProtocolOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSearchDirectConnect": { + "type_name": "NullableSearchDirectConnect", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSearchDirectConnectState": { + "type_name": "NullableSearchDirectConnectState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSearchDirectConnectType": { + "type_name": "NullableSearchDirectConnectType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSearchExpression": { + "type_name": "NullableSearchExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSearchFieldName": { + "type_name": "NullableSearchFieldName", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSearchRequest": { + "type_name": "NullableSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSearchResponse": { + "type_name": "NullableSearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceMetro": { + "type_name": "NullableServiceMetro", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceMetros": { + "type_name": "NullableServiceMetros", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfile": { + "type_name": "NullableServiceProfile", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileAccessPointCOLO": { + "type_name": "NullableServiceProfileAccessPointCOLO", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileAccessPointCOLOType": { + "type_name": "NullableServiceProfileAccessPointCOLOType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileAccessPointType": { + "type_name": "NullableServiceProfileAccessPointType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileAccessPointTypeCOLO": { + "type_name": "NullableServiceProfileAccessPointTypeCOLO", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileAccessPointTypeEnum": { + "type_name": "NullableServiceProfileAccessPointTypeEnum", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileAccessPointTypeVD": { + "type_name": "NullableServiceProfileAccessPointTypeVD", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileAccessPointVD": { + "type_name": "NullableServiceProfileAccessPointVD", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileAccessPointVDType": { + "type_name": "NullableServiceProfileAccessPointVDType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileAndFilter": { + "type_name": "NullableServiceProfileAndFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileFilter": { + "type_name": "NullableServiceProfileFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileLinkProtocolConfig": { + "type_name": "NullableServiceProfileLinkProtocolConfig", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileLinkProtocolConfigEncapsulation": { + "type_name": "NullableServiceProfileLinkProtocolConfigEncapsulation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileLinkProtocolConfigEncapsulationStrategy": { + "type_name": "NullableServiceProfileLinkProtocolConfigEncapsulationStrategy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileMetadata": { + "type_name": "NullableServiceProfileMetadata", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileRequest": { + "type_name": "NullableServiceProfileRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileSearchRequest": { + "type_name": "NullableServiceProfileSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileSimpleExpression": { + "type_name": "NullableServiceProfileSimpleExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileSortBy": { + "type_name": "NullableServiceProfileSortBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileSortCriteria": { + "type_name": "NullableServiceProfileSortCriteria", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileSortDirection": { + "type_name": "NullableServiceProfileSortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileStateEnum": { + "type_name": "NullableServiceProfileStateEnum", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileTypeEnum": { + "type_name": "NullableServiceProfileTypeEnum", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfileVisibilityEnum": { + "type_name": "NullableServiceProfileVisibilityEnum", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceProfiles": { + "type_name": "NullableServiceProfiles", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceSearchResponse": { + "type_name": "NullableServiceSearchResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceToken": { + "type_name": "NullableServiceToken", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenActionRequest": { + "type_name": "NullableServiceTokenActionRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenActions": { + "type_name": "NullableServiceTokenActions", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenChangeOperation": { + "type_name": "NullableServiceTokenChangeOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenConnection": { + "type_name": "NullableServiceTokenConnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenConnectionType": { + "type_name": "NullableServiceTokenConnectionType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenSearchExpression": { + "type_name": "NullableServiceTokenSearchExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenSearchExpressionOperator": { + "type_name": "NullableServiceTokenSearchExpressionOperator", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenSearchFieldName": { + "type_name": "NullableServiceTokenSearchFieldName", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenSearchRequest": { + "type_name": "NullableServiceTokenSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenSide": { + "type_name": "NullableServiceTokenSide", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenState": { + "type_name": "NullableServiceTokenState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokenType": { + "type_name": "NullableServiceTokenType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServiceTokens": { + "type_name": "NullableServiceTokens", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServices": { + "type_name": "NullableServices", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedAccount": { + "type_name": "NullableSimplifiedAccount", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedLinkProtocol": { + "type_name": "NullableSimplifiedLinkProtocol", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedLocation": { + "type_name": "NullableSimplifiedLocation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedLocationWithoutIBX": { + "type_name": "NullableSimplifiedLocationWithoutIBX", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedMetadataEntity": { + "type_name": "NullableSimplifiedMetadataEntity", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedNetwork": { + "type_name": "NullableSimplifiedNetwork", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedNetworkChange": { + "type_name": "NullableSimplifiedNetworkChange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedNotification": { + "type_name": "NullableSimplifiedNotification", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedNotificationType": { + "type_name": "NullableSimplifiedNotificationType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedPort": { + "type_name": "NullableSimplifiedPort", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedServiceProfile": { + "type_name": "NullableSimplifiedServiceProfile", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedTokenNetwork": { + "type_name": "NullableSimplifiedTokenNetwork", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedTokenNetworkScope": { + "type_name": "NullableSimplifiedTokenNetworkScope", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedTokenNetworkType": { + "type_name": "NullableSimplifiedTokenNetworkType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedVirtualDevice": { + "type_name": "NullableSimplifiedVirtualDevice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSimplifiedVirtualDeviceType": { + "type_name": "NullableSimplifiedVirtualDeviceType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSortBy": { + "type_name": "NullableSortBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSortCriteria": { + "type_name": "NullableSortCriteria", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSortCriteriaResponse": { + "type_name": "NullableSortCriteriaResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSortDirection": { + "type_name": "NullableSortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSortItem": { + "type_name": "NullableSortItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSortItemDirection": { + "type_name": "NullableSortItemDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSortItemProperty": { + "type_name": "NullableSortItemProperty", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStatistics": { + "type_name": "NullableStatistics", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStatisticsViewPoint": { + "type_name": "NullableStatisticsViewPoint", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStream": { + "type_name": "NullableStream", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAlertRule": { + "type_name": "NullableStreamAlertRule", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAlertRuleState": { + "type_name": "NullableStreamAlertRuleState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAlertRuleType": { + "type_name": "NullableStreamAlertRuleType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAsset": { + "type_name": "NullableStreamAsset", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAssetAttachmentStatus": { + "type_name": "NullableStreamAssetAttachmentStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAssetFilter": { + "type_name": "NullableStreamAssetFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAssetFilters": { + "type_name": "NullableStreamAssetFilters", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAssetOrFilter": { + "type_name": "NullableStreamAssetOrFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAssetPutRequest": { + "type_name": "NullableStreamAssetPutRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAssetSearchRequest": { + "type_name": "NullableStreamAssetSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAssetSimpleExpression": { + "type_name": "NullableStreamAssetSimpleExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAssetSortBy": { + "type_name": "NullableStreamAssetSortBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAssetSortCriteria": { + "type_name": "NullableStreamAssetSortCriteria", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAssetSortDirection": { + "type_name": "NullableStreamAssetSortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamAssetType": { + "type_name": "NullableStreamAssetType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamFilter": { + "type_name": "NullableStreamFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamFilterOrFilter": { + "type_name": "NullableStreamFilterOrFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamFilterSimpleExpression": { + "type_name": "NullableStreamFilterSimpleExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamPostRequest": { + "type_name": "NullableStreamPostRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamPostRequestType": { + "type_name": "NullableStreamPostRequestType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamPutRequest": { + "type_name": "NullableStreamPutRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamState": { + "type_name": "NullableStreamState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscription": { + "type_name": "NullableStreamSubscription", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionFilter": { + "type_name": "NullableStreamSubscriptionFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionOperation": { + "type_name": "NullableStreamSubscriptionOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionOperationAdditionalInfo": { + "type_name": "NullableStreamSubscriptionOperationAdditionalInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionOperationErrors": { + "type_name": "NullableStreamSubscriptionOperationErrors", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionPostRequest": { + "type_name": "NullableStreamSubscriptionPostRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionPostRequestType": { + "type_name": "NullableStreamSubscriptionPostRequestType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionPutRequest": { + "type_name": "NullableStreamSubscriptionPutRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionSelector": { + "type_name": "NullableStreamSubscriptionSelector", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionSink": { + "type_name": "NullableStreamSubscriptionSink", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionSinkCredential": { + "type_name": "NullableStreamSubscriptionSinkCredential", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionSinkCredentialType": { + "type_name": "NullableStreamSubscriptionSinkCredentialType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionSinkResponse": { + "type_name": "NullableStreamSubscriptionSinkResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionSinkSetting": { + "type_name": "NullableStreamSubscriptionSinkSetting", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionSinkSettingFormat": { + "type_name": "NullableStreamSubscriptionSinkSettingFormat", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionSinkType": { + "type_name": "NullableStreamSubscriptionSinkType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionState": { + "type_name": "NullableStreamSubscriptionState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamSubscriptionType": { + "type_name": "NullableStreamSubscriptionType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStreamType": { + "type_name": "NullableStreamType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableString": { + "type_name": "NullableString", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubInterface": { + "type_name": "NullableSubInterface", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubnet": { + "type_name": "NullableSubnet", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubnetType": { + "type_name": "NullableSubnetType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubscriptionAsset": { + "type_name": "NullableSubscriptionAsset", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubscriptionEntitlementResponse": { + "type_name": "NullableSubscriptionEntitlementResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubscriptionResponse": { + "type_name": "NullableSubscriptionResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubscriptionResponseMarketplace": { + "type_name": "NullableSubscriptionResponseMarketplace", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubscriptionResponseOfferType": { + "type_name": "NullableSubscriptionResponseOfferType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubscriptionRouterPackageType": { + "type_name": "NullableSubscriptionRouterPackageType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubscriptionRouterPackageTypeCode": { + "type_name": "NullableSubscriptionRouterPackageTypeCode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubscriptionState": { + "type_name": "NullableSubscriptionState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSubscriptionTrial": { + "type_name": "NullableSubscriptionTrial", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTime": { + "type_name": "NullableTime", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServiceFilter": { + "type_name": "NullableTimeServiceFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServiceFilters": { + "type_name": "NullableTimeServiceFilters", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServiceOperation": { + "type_name": "NullableTimeServiceOperation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServiceOperationOperationalStatus": { + "type_name": "NullableTimeServiceOperationOperationalStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServiceOrFilter": { + "type_name": "NullableTimeServiceOrFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServicePrice": { + "type_name": "NullableTimeServicePrice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServicePriceConnection": { + "type_name": "NullableTimeServicePriceConnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServicePriceConnectionASide": { + "type_name": "NullableTimeServicePriceConnectionASide", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServicePriceConnectionAccessPoint": { + "type_name": "NullableTimeServicePriceConnectionAccessPoint", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServiceSimpleExpression": { + "type_name": "NullableTimeServiceSimpleExpression", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServiceSortBy": { + "type_name": "NullableTimeServiceSortBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServiceSortCriteria": { + "type_name": "NullableTimeServiceSortCriteria", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServiceSortDirection": { + "type_name": "NullableTimeServiceSortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTimeServicesSearchRequest": { + "type_name": "NullableTimeServicesSearchRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTopologyProperties": { + "type_name": "NullableTopologyProperties", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVPC": { + "type_name": "NullableVPC", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVPCState": { + "type_name": "NullableVPCState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVPCType": { + "type_name": "NullableVPCType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableValidateConnectionResponse": { + "type_name": "NullableValidateConnectionResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableValidateRequest": { + "type_name": "NullableValidateRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableValidateRequestFilter": { + "type_name": "NullableValidateRequestFilter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableValidateRequestFilterAnd": { + "type_name": "NullableValidateRequestFilterAnd", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableValidateSubnetResponse": { + "type_name": "NullableValidateSubnetResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableViewPoint": { + "type_name": "NullableViewPoint", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionBridgePackageCode": { + "type_name": "NullableVirtualConnectionBridgePackageCode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPrice": { + "type_name": "NullableVirtualConnectionPrice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPriceASide": { + "type_name": "NullableVirtualConnectionPriceASide", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPriceASideAccessPoint": { + "type_name": "NullableVirtualConnectionPriceASideAccessPoint", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPriceASideAccessPointPort": { + "type_name": "NullableVirtualConnectionPriceASideAccessPointPort", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPriceASideAccessPointPortSettings": { + "type_name": "NullableVirtualConnectionPriceASideAccessPointPortSettings", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPriceAccessPointType": { + "type_name": "NullableVirtualConnectionPriceAccessPointType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPriceConnectionType": { + "type_name": "NullableVirtualConnectionPriceConnectionType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPriceZSide": { + "type_name": "NullableVirtualConnectionPriceZSide", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPriceZSideAccessPoint": { + "type_name": "NullableVirtualConnectionPriceZSideAccessPoint", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPriceZSideAccessPointBridge": { + "type_name": "NullableVirtualConnectionPriceZSideAccessPointBridge", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPriceZSideAccessPointBridgePackage": { + "type_name": "NullableVirtualConnectionPriceZSideAccessPointBridgePackage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionPriceZSideAccessPointProfile": { + "type_name": "NullableVirtualConnectionPriceZSideAccessPointProfile", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionSide": { + "type_name": "NullableVirtualConnectionSide", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionTimeServiceResponse": { + "type_name": "NullableVirtualConnectionTimeServiceResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualConnectionUuid": { + "type_name": "NullableVirtualConnectionUuid", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualDevice": { + "type_name": "NullableVirtualDevice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualDeviceInterface": { + "type_name": "NullableVirtualDeviceInterface", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualDeviceInterfaceType": { + "type_name": "NullableVirtualDeviceInterfaceType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualDeviceType": { + "type_name": "NullableVirtualDeviceType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualNetwork": { + "type_name": "NullableVirtualNetwork", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualPortConfiguration": { + "type_name": "NullableVirtualPortConfiguration", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualPortLocation": { + "type_name": "NullableVirtualPortLocation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualPortPackage": { + "type_name": "NullableVirtualPortPackage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualPortPrice": { + "type_name": "NullableVirtualPortPrice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualPortRedundancy": { + "type_name": "NullableVirtualPortRedundancy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualPortServiceType": { + "type_name": "NullableVirtualPortServiceType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualPortType": { + "type_name": "NullableVirtualPortType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVpicInterface": { + "type_name": "NullableVpicInterface", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "Operation": { + "type_name": "Operation", + "description": "Operation Operation object for router actions", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpIpv4RoutesCount": { + "name": "BgpIpv4RoutesCount", + "description": "IPV4 route count", + "json_tag": "bgpIpv4RoutesCount" + }, + "BgpIpv6RoutesCount": { + "name": "BgpIpv6RoutesCount", + "description": "IPV6 route count", + "json_tag": "bgpIpv6RoutesCount" + }, + "DistinctIpv4PrefixesCount": { + "name": "DistinctIpv4PrefixesCount", + "description": "distinct IPV4 prefixes count", + "json_tag": "distinctIpv4PrefixesCount" + }, + "DistinctIpv6PrefixesCount": { + "name": "DistinctIpv6PrefixesCount", + "description": "distinct IPV6 prefixes count", + "json_tag": "distinctIpv6PrefixesCount" + } + } + }, + "OperationalStatus": { + "type_name": "OperationalStatus", + "description": "OperationalStatus struct for OperationalStatus", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "OperationalStatus": { + "name": "OperationalStatus", + "description": "Operational status for the resource target of the event", + "json_tag": "operationalStatus" + } + } + }, + "OrchestratorProviders": { + "type_name": "OrchestratorProviders", + "description": "OrchestratorProviders - The OrchestratorProvider schema defines the structure for the orchestrator provider configuration. It includes details about the provider type and its specific configurations.", + "fields": { + "AWSProvider": { + "name": "AWSProvider", + "description": "" + }, + "FabricProvider": { + "name": "FabricProvider", + "description": "" + }, + "GCPProvider": { + "name": "GCPProvider", + "description": "" + } + } + }, + "Order": { + "type_name": "Order", + "description": "Order struct for Order", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BillingTier": { + "name": "BillingTier", + "description": "Billing tier for connection bandwidth", + "json_tag": "billingTier" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "Customer reference number", + "json_tag": "customerReferenceNumber" + }, + "OrderId": { + "name": "OrderId", + "description": "Order Identification", + "json_tag": "orderId" + }, + "OrderNumber": { + "name": "OrderNumber", + "description": "Order Reference Number", + "json_tag": "orderNumber" + }, + "PurchaseOrderNumber": { + "name": "PurchaseOrderNumber", + "description": "Purchase order number", + "json_tag": "purchaseOrderNumber" + }, + "TermLength": { + "name": "TermLength", + "description": "Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case).", + "json_tag": "termLength" + } + } + }, + "OutputStructuredPing": { + "type_name": "OutputStructuredPing", + "description": "OutputStructuredPing struct for OutputStructuredPing", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DataBytes": { + "name": "DataBytes", + "description": "", + "json_tag": "dataBytes" + }, + "DestinationIp": { + "name": "DestinationIp", + "description": "", + "json_tag": "destinationIp" + }, + "DestinationName": { + "name": "DestinationName", + "description": "", + "json_tag": "destinationName" + }, + "PacketsLossPercent": { + "name": "PacketsLossPercent", + "description": "", + "json_tag": "packetsLossPercent" + }, + "PacketsReceived": { + "name": "PacketsReceived", + "description": "", + "json_tag": "packetsReceived" + }, + "PacketsTransmitted": { + "name": "PacketsTransmitted", + "description": "", + "json_tag": "packetsTransmitted" + }, + "Responses": { + "name": "Responses", + "description": "", + "json_tag": "responses" + }, + "RttAvg": { + "name": "RttAvg", + "description": "", + "json_tag": "rttAvg" + }, + "RttMax": { + "name": "RttMax", + "description": "", + "json_tag": "rttMax" + }, + "RttMin": { + "name": "RttMin", + "description": "", + "json_tag": "rttMin" + }, + "RttStdDev": { + "name": "RttStdDev", + "description": "", + "json_tag": "rttStdDev" + } + } + }, + "OutputStructuredPingResponseItem": { + "type_name": "OutputStructuredPingResponseItem", + "description": "OutputStructuredPingResponseItem struct for OutputStructuredPingResponseItem", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bytes": { + "name": "Bytes", + "description": "", + "json_tag": "bytes" + }, + "IcmpSeq": { + "name": "IcmpSeq", + "description": "", + "json_tag": "icmpSeq" + }, + "Ip": { + "name": "Ip", + "description": "", + "json_tag": "ip" + }, + "Time": { + "name": "Time", + "description": "", + "json_tag": "time" + }, + "Ttl": { + "name": "Ttl", + "description": "", + "json_tag": "ttl" + } + } + }, + "OutputStructuredTraceroute": { + "type_name": "OutputStructuredTraceroute", + "description": "OutputStructuredTraceroute struct for OutputStructuredTraceroute", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DestinationIp": { + "name": "DestinationIp", + "description": "", + "json_tag": "destinationIp" + }, + "DestinationName": { + "name": "DestinationName", + "description": "", + "json_tag": "destinationName" + }, + "Hops": { + "name": "Hops", + "description": "", + "json_tag": "hops" + }, + "HopsMax": { + "name": "HopsMax", + "description": "", + "json_tag": "hopsMax" + }, + "PacketBytes": { + "name": "PacketBytes", + "description": "", + "json_tag": "packetBytes" + } + } + }, + "Package": { + "type_name": "Package", + "description": "Package Package settings for port", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "PackageChangeLog": { + "type_name": "PackageChangeLog", + "description": "PackageChangeLog Cloud Router package change log", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "", + "json_tag": "createdDateTime" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "", + "json_tag": "updatedDateTime" + } + } + }, + "PackageResponse": { + "type_name": "PackageResponse", + "description": "PackageResponse struct for PackageResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "Pagination": { + "type_name": "Pagination", + "description": "Pagination Pagination response information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Limit": { + "name": "Limit", + "description": "Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.", + "json_tag": "limit" + }, + "Next": { + "name": "Next", + "description": "URL relative to the next item in the response.", + "json_tag": "next" + }, + "Offset": { + "name": "Offset", + "description": "Index of the first item returned in the response. The default is 0.", + "json_tag": "offset" + }, + "Previous": { + "name": "Previous", + "description": "URL relative to the previous item in the response.", + "json_tag": "previous" + }, + "Total": { + "name": "Total", + "description": "Total number of elements returned.", + "json_tag": "total" + } + } + }, + "PaginationRequest": { + "type_name": "PaginationRequest", + "description": "PaginationRequest Pagination request information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Limit": { + "name": "Limit", + "description": "Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.", + "json_tag": "limit" + }, + "Offset": { + "name": "Offset", + "description": "Index of the first element.", + "json_tag": "offset" + } + } + }, + "PhysicalPort": { + "type_name": "PhysicalPort", + "description": "PhysicalPort Physical Port specification", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Physical Port additional information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DemarcationPoint": { + "name": "DemarcationPoint", + "description": "", + "json_tag": "demarcationPoint" + }, + "Href": { + "name": "Href", + "description": "Equinix assigned response attribute for an absolute URL that is the subject of the link's context.", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "Equinix assigned response attribute for Physical Port Id\nDeprecated", + "json_tag": "id" + }, + "Interface": { + "name": "Interface", + "description": "", + "json_tag": "interface" + }, + "InterfaceSpeed": { + "name": "InterfaceSpeed", + "description": "Physical Port Speed in Mbps", + "json_tag": "interfaceSpeed" + }, + "InterfaceType": { + "name": "InterfaceType", + "description": "Physical Port Interface Type", + "json_tag": "interfaceType" + }, + "Loas": { + "name": "Loas", + "description": "Port Loas", + "json_tag": "loas" + }, + "Notifications": { + "name": "Notifications", + "description": "Notification preferences", + "json_tag": "notifications" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Settings": { + "name": "Settings", + "description": "", + "json_tag": "settings" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Tether": { + "name": "Tether", + "description": "", + "json_tag": "tether" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix assigned response attribute for physical port identifier", + "json_tag": "uuid" + } + } + }, + "PhysicalPortSettings": { + "type_name": "PhysicalPortSettings", + "description": "PhysicalPortSettings Physical Port configuration settings", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ErrorMessage": { + "name": "ErrorMessage", + "description": "", + "json_tag": "errorMessage" + }, + "PackageType": { + "name": "PackageType", + "description": "Deprecated", + "json_tag": "packageType" + } + } + }, + "Port": { + "type_name": "Port", + "description": "Port Port specification", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Port additional information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Asn": { + "name": "Asn", + "description": "Port ASN", + "json_tag": "asn" + }, + "AvailableBandwidth": { + "name": "AvailableBandwidth", + "description": "Equinix assigned response attribute for Port available bandwidth in Mbps", + "json_tag": "availableBandwidth" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Equinix assigned response attribute for Port bandwidth in Mbps\nDeprecated", + "json_tag": "bandwidth" + }, + "BmmrType": { + "name": "BmmrType", + "description": "", + "json_tag": "bmmrType" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "ConnectionsCount": { + "name": "ConnectionsCount", + "description": "Equinix assigned response attribute for Connection count", + "json_tag": "connectionsCount" + }, + "ConnectivitySourceType": { + "name": "ConnectivitySourceType", + "description": "", + "json_tag": "connectivitySourceType" + }, + "DemarcationPoint": { + "name": "DemarcationPoint", + "description": "", + "json_tag": "demarcationPoint" + }, + "DemarcationPointIbx": { + "name": "DemarcationPointIbx", + "description": "A-side/Equinix ibx", + "json_tag": "demarcationPointIbx" + }, + "Description": { + "name": "Description", + "description": "Equinix assigned response attribute for Port description", + "json_tag": "description" + }, + "Device": { + "name": "Device", + "description": "", + "json_tag": "device" + }, + "Encapsulation": { + "name": "Encapsulation", + "description": "", + "json_tag": "encapsulation" + }, + "EndCustomer": { + "name": "EndCustomer", + "description": "", + "json_tag": "endCustomer" + }, + "Href": { + "name": "Href", + "description": "Equinix assigned response attribute for an absolute URL that is the subject of the link's context.", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "Equinix assigned response attribute for Port Id", + "json_tag": "id" + }, + "Interface": { + "name": "Interface", + "description": "", + "json_tag": "interface" + }, + "Lag": { + "name": "Lag", + "description": "", + "json_tag": "lag" + }, + "LagEnabled": { + "name": "LagEnabled", + "description": "If LAG enabled", + "json_tag": "lagEnabled" + }, + "Loas": { + "name": "Loas", + "description": "Port Loas", + "json_tag": "loas" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Name": { + "name": "Name", + "description": "Equinix assigned response attribute for Port name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Notification preferences", + "json_tag": "notifications" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "PhysicalPortQuantity": { + "name": "PhysicalPortQuantity", + "description": "Number of physical ports", + "json_tag": "physicalPortQuantity" + }, + "PhysicalPorts": { + "name": "PhysicalPorts", + "description": "Physical ports that implement this port", + "json_tag": "physicalPorts" + }, + "PhysicalPortsCount": { + "name": "PhysicalPortsCount", + "description": "", + "json_tag": "physicalPortsCount" + }, + "PhysicalPortsSpeed": { + "name": "PhysicalPortsSpeed", + "description": "Physical Ports Speed in Mbps", + "json_tag": "physicalPortsSpeed" + }, + "PhysicalPortsType": { + "name": "PhysicalPortsType", + "description": "", + "json_tag": "physicalPortsType" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Redundancy": { + "name": "Redundancy", + "description": "", + "json_tag": "redundancy" + }, + "ServiceType": { + "name": "ServiceType", + "description": "Deprecated", + "json_tag": "serviceType" + }, + "Settings": { + "name": "Settings", + "description": "", + "json_tag": "settings" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "TetherIbx": { + "name": "TetherIbx", + "description": "z-side/Equinix ibx", + "json_tag": "tetherIbx" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UsedBandwidth": { + "name": "UsedBandwidth", + "description": "Equinix assigned response attribute for Port used bandwidth in Mbps", + "json_tag": "usedBandwidth" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix assigned response attribute for port identifier", + "json_tag": "uuid" + } + } + }, + "PortAdditionalInfo": { + "type_name": "PortAdditionalInfo", + "description": "PortAdditionalInfo Additional information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Key": { + "name": "Key", + "description": "Key", + "json_tag": "key" + }, + "Value": { + "name": "Value", + "description": "Value", + "json_tag": "value" + } + } + }, + "PortChange": { + "type_name": "PortChange", + "description": "PortChange Current state of latest port change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Set when change flow starts", + "json_tag": "createdDateTime" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Information": { + "name": "Information", + "description": "Additional information", + "json_tag": "information" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "Set when change object is updated", + "json_tag": "updatedDateTime" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "PortChangeOperation": { + "type_name": "PortChangeOperation", + "description": "PortChangeOperation Port change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "Handy shortcut for operation name", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path inside document leading to updated parameter", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "new value for updated parameter", + "json_tag": "value" + } + } + }, + "PortDemarcationPoint": { + "type_name": "PortDemarcationPoint", + "description": "PortDemarcationPoint Customer physical Port", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CabinetUniqueSpaceId": { + "name": "CabinetUniqueSpaceId", + "description": "Port cabinet unique space id", + "json_tag": "cabinetUniqueSpaceId" + }, + "CageUniqueSpaceId": { + "name": "CageUniqueSpaceId", + "description": "Port cage unique space id", + "json_tag": "cageUniqueSpaceId" + }, + "ConnectorType": { + "name": "ConnectorType", + "description": "Port connector type", + "json_tag": "connectorType" + }, + "Ibx": { + "name": "Ibx", + "description": "Port ibx identifier", + "json_tag": "ibx" + }, + "PatchPanel": { + "name": "PatchPanel", + "description": "Port patch panel", + "json_tag": "patchPanel" + }, + "PatchPanelName": { + "name": "PatchPanelName", + "description": "Port patch panel\nDeprecated", + "json_tag": "patchPanelName" + }, + "PatchPanelPortA": { + "name": "PatchPanelPortA", + "description": "Port patch panel port A", + "json_tag": "patchPanelPortA" + }, + "PatchPanelPortB": { + "name": "PatchPanelPortB", + "description": "Port patch panel port B", + "json_tag": "patchPanelPortB" + } + } + }, + "PortDevice": { + "type_name": "PortDevice", + "description": "PortDevice Port device", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Name": { + "name": "Name", + "description": "Device name\nDeprecated", + "json_tag": "name" + }, + "Redundancy": { + "name": "Redundancy", + "description": "", + "json_tag": "redundancy" + }, + "VcBandwidthMax": { + "name": "VcBandwidthMax", + "description": "Maximum bandwidth allowed for connection.", + "json_tag": "vcBandwidthMax" + } + } + }, + "PortDeviceRedundancy": { + "type_name": "PortDeviceRedundancy", + "description": "PortDeviceRedundancy Device redundancy", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Group": { + "name": "Group", + "description": "Device redundancy group", + "json_tag": "group" + }, + "Priority": { + "name": "Priority", + "description": "", + "json_tag": "priority" + } + } + }, + "PortEncapsulation": { + "type_name": "PortEncapsulation", + "description": "PortEncapsulation Port encapsulation configuration", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "TagProtocolId": { + "name": "TagProtocolId", + "description": "Port encapsulation tag protocol identifier", + "json_tag": "tagProtocolId" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "PortExpression": { + "type_name": "PortExpression", + "description": "PortExpression Either use 'and' for AND operations, 'or' for OR operations, or specify 'property', 'operator', and 'values' for field filtering. Only one of these patterns should be used at a time.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + }, + "Operator": { + "name": "Operator", + "description": "", + "json_tag": "operator" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "PortInterface": { + "type_name": "PortInterface", + "description": "PortInterface Port interface", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Type": { + "name": "Type", + "description": "Port interface type", + "json_tag": "type" + } + } + }, + "PortLag": { + "type_name": "PortLag", + "description": "PortLag Port Lag", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Enabled": { + "name": "Enabled", + "description": "enabled\nDeprecated", + "json_tag": "enabled" + }, + "Id": { + "name": "Id", + "description": "id", + "json_tag": "id" + }, + "MemberStatus": { + "name": "MemberStatus", + "description": "member status", + "json_tag": "memberStatus" + }, + "Name": { + "name": "Name", + "description": "name", + "json_tag": "name" + } + } + }, + "PortLoa": { + "type_name": "PortLoa", + "description": "PortLoa Port Loas", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Type": { + "name": "Type", + "description": "Loa type", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "uuid", + "json_tag": "uuid" + } + } + }, + "PortNotification": { + "type_name": "PortNotification", + "description": "PortNotification struct for PortNotification", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "RegisteredUsers": { + "name": "RegisteredUsers", + "description": "Array of registered users", + "json_tag": "registeredUsers" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "PortOperation": { + "type_name": "PortOperation", + "description": "PortOperation Operational specifications for ports.", + "fields": { + "AccessVCCount": { + "name": "AccessVCCount", + "description": "Total number of connections.", + "json_tag": "accessVCCount" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ConnectionCount": { + "name": "ConnectionCount", + "description": "Total number of connections.", + "json_tag": "connectionCount" + }, + "EvplVCCount": { + "name": "EvplVCCount", + "description": "Total number of connections.", + "json_tag": "evplVCCount" + }, + "FgVCCount": { + "name": "FgVCCount", + "description": "Total number of connections.", + "json_tag": "fgVCCount" + }, + "OpStatusChangedAt": { + "name": "OpStatusChangedAt", + "description": "Date and time at which port availability changed.", + "json_tag": "opStatusChangedAt" + }, + "OperationalStatus": { + "name": "OperationalStatus", + "description": "", + "json_tag": "operationalStatus" + } + } + }, + "PortOrder": { + "type_name": "PortOrder", + "description": "PortOrder struct for PortOrder", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerReferenceId": { + "name": "CustomerReferenceId", + "description": "Customer order reference Id", + "json_tag": "customerReferenceId" + }, + "OrderId": { + "name": "OrderId", + "description": "Order Identification", + "json_tag": "orderId" + }, + "OrderNumber": { + "name": "OrderNumber", + "description": "Order Reference Number", + "json_tag": "orderNumber" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Signature": { + "name": "Signature", + "description": "", + "json_tag": "signature" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned order identifier, this is a derived response atrribute\nDeprecated", + "json_tag": "uuid" + } + } + }, + "PortOrderPurchaseOrder": { + "type_name": "PortOrderPurchaseOrder", + "description": "PortOrderPurchaseOrder purchase order", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Amount": { + "name": "Amount", + "description": "purchase order amount", + "json_tag": "amount" + }, + "AttachmentId": { + "name": "AttachmentId", + "description": "", + "json_tag": "attachmentId" + }, + "EndDate": { + "name": "EndDate", + "description": "", + "json_tag": "endDate" + }, + "Number": { + "name": "Number", + "description": "purchase order number", + "json_tag": "number" + }, + "SelectionType": { + "name": "SelectionType", + "description": "Deprecated", + "json_tag": "selectionType" + }, + "StartDate": { + "name": "StartDate", + "description": "", + "json_tag": "startDate" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "PortOrderSignature": { + "type_name": "PortOrderSignature", + "description": "PortOrderSignature Port signature Type", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Delegate": { + "name": "Delegate", + "description": "", + "json_tag": "delegate" + }, + "Signatory": { + "name": "Signatory", + "description": "", + "json_tag": "signatory" + } + } + }, + "PortOrderSignatureDelegate": { + "type_name": "PortOrderSignatureDelegate", + "description": "PortOrderSignatureDelegate delegate oder details", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Email": { + "name": "Email", + "description": "email of delegate", + "json_tag": "email" + }, + "FirstName": { + "name": "FirstName", + "description": "name of delegate", + "json_tag": "firstName" + }, + "LastName": { + "name": "LastName", + "description": "last Name of delegate", + "json_tag": "lastName" + } + } + }, + "PortPackage": { + "type_name": "PortPackage", + "description": "PortPackage Port Package details", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "Port Package code", + "json_tag": "code" + }, + "Href": { + "name": "Href", + "description": "Port Package URI", + "json_tag": "href" + }, + "SupportedMetros": { + "name": "SupportedMetros", + "description": "List of supported metros", + "json_tag": "supportedMetros" + }, + "SupportedServiceTypes": { + "name": "SupportedServiceTypes", + "description": "List of supported service types", + "json_tag": "supportedServiceTypes" + }, + "SupportedSourceTypes": { + "name": "SupportedSourceTypes", + "description": "List of supported source types", + "json_tag": "supportedSourceTypes" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "VcBandwidthMax": { + "name": "VcBandwidthMax", + "description": "Maximum virtual connection bandwidth in Mbps", + "json_tag": "vcBandwidthMax" + }, + "VcRemoteSupported": { + "name": "VcRemoteSupported", + "description": "Indicates if remote virtual connections are supported", + "json_tag": "vcRemoteSupported" + } + } + }, + "PortRedundancy": { + "type_name": "PortRedundancy", + "description": "PortRedundancy Port redundancy configuration", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Enabled": { + "name": "Enabled", + "description": "Access point redundancy", + "json_tag": "enabled" + }, + "Group": { + "name": "Group", + "description": "Port UUID of respective primary port\nDeprecated", + "json_tag": "group" + }, + "Priority": { + "name": "Priority", + "description": "", + "json_tag": "priority" + } + } + }, + "PortRequest": { + "type_name": "PortRequest", + "description": "PortRequest PortRequest is the Request Object for creating single and bulk fabric ports", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Port additional information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Asn": { + "name": "Asn", + "description": "Port ASN", + "json_tag": "asn" + }, + "AvailableBandwidth": { + "name": "AvailableBandwidth", + "description": "Equinix assigned response attribute for Port available bandwidth in Mbps", + "json_tag": "availableBandwidth" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Equinix assigned response attribute for Port bandwidth in Mbps\nDeprecated", + "json_tag": "bandwidth" + }, + "BmmrType": { + "name": "BmmrType", + "description": "", + "json_tag": "bmmrType" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "ConnectionsCount": { + "name": "ConnectionsCount", + "description": "Equinix assigned response attribute for Connection count", + "json_tag": "connectionsCount" + }, + "ConnectivitySourceType": { + "name": "ConnectivitySourceType", + "description": "", + "json_tag": "connectivitySourceType" + }, + "DemarcationPoint": { + "name": "DemarcationPoint", + "description": "", + "json_tag": "demarcationPoint" + }, + "DemarcationPointIbx": { + "name": "DemarcationPointIbx", + "description": "A-side/Equinix ibx", + "json_tag": "demarcationPointIbx" + }, + "Description": { + "name": "Description", + "description": "Equinix assigned response attribute for Port description", + "json_tag": "description" + }, + "Device": { + "name": "Device", + "description": "", + "json_tag": "device" + }, + "Encapsulation": { + "name": "Encapsulation", + "description": "", + "json_tag": "encapsulation" + }, + "EndCustomer": { + "name": "EndCustomer", + "description": "", + "json_tag": "endCustomer" + }, + "Href": { + "name": "Href", + "description": "Equinix assigned response attribute for an absolute URL that is the subject of the link's context.", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "Equinix assigned response attribute for Port Id", + "json_tag": "id" + }, + "Interface": { + "name": "Interface", + "description": "", + "json_tag": "interface" + }, + "Lag": { + "name": "Lag", + "description": "", + "json_tag": "lag" + }, + "LagEnabled": { + "name": "LagEnabled", + "description": "If LAG enabled", + "json_tag": "lagEnabled" + }, + "Loas": { + "name": "Loas", + "description": "Port Loas", + "json_tag": "loas" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Name": { + "name": "Name", + "description": "Equinix assigned response attribute for Port name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Notification preferences", + "json_tag": "notifications" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "PhysicalPortQuantity": { + "name": "PhysicalPortQuantity", + "description": "Number of physical ports", + "json_tag": "physicalPortQuantity" + }, + "PhysicalPorts": { + "name": "PhysicalPorts", + "description": "Physical ports that implement this port", + "json_tag": "physicalPorts" + }, + "PhysicalPortsCount": { + "name": "PhysicalPortsCount", + "description": "", + "json_tag": "physicalPortsCount" + }, + "PhysicalPortsSpeed": { + "name": "PhysicalPortsSpeed", + "description": "Physical Ports Speed in Mbps", + "json_tag": "physicalPortsSpeed" + }, + "PhysicalPortsType": { + "name": "PhysicalPortsType", + "description": "", + "json_tag": "physicalPortsType" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Redundancy": { + "name": "Redundancy", + "description": "", + "json_tag": "redundancy" + }, + "ServiceType": { + "name": "ServiceType", + "description": "Deprecated", + "json_tag": "serviceType" + }, + "Settings": { + "name": "Settings", + "description": "", + "json_tag": "settings" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "TetherIbx": { + "name": "TetherIbx", + "description": "z-side/Equinix ibx", + "json_tag": "tetherIbx" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UsedBandwidth": { + "name": "UsedBandwidth", + "description": "Equinix assigned response attribute for Port used bandwidth in Mbps", + "json_tag": "usedBandwidth" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix assigned response attribute for port identifier", + "json_tag": "uuid" + } + } + }, + "PortSettings": { + "type_name": "PortSettings", + "description": "PortSettings Port configuration settings", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Buyout": { + "name": "Buyout", + "description": "Deprecated", + "json_tag": "buyout" + }, + "Layer3Enabled": { + "name": "Layer3Enabled", + "description": "Deprecated", + "json_tag": "layer3Enabled" + }, + "PackageType": { + "name": "PackageType", + "description": "Deprecated", + "json_tag": "packageType" + }, + "PlaceVcOrderPermission": { + "name": "PlaceVcOrderPermission", + "description": "Deprecated", + "json_tag": "placeVcOrderPermission" + }, + "SharedPortProduct": { + "name": "SharedPortProduct", + "description": "", + "json_tag": "sharedPortProduct" + }, + "SharedPortType": { + "name": "SharedPortType", + "description": "", + "json_tag": "sharedPortType" + }, + "ViewPortPermission": { + "name": "ViewPortPermission", + "description": "Deprecated", + "json_tag": "viewPortPermission" + } + } + }, + "PortSortCriteria": { + "type_name": "PortSortCriteria", + "description": "PortSortCriteria struct for PortSortCriteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "PortTether": { + "type_name": "PortTether", + "description": "PortTether Port physical connection", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CabinetNumber": { + "name": "CabinetNumber", + "description": "Port cabinet number", + "json_tag": "cabinetNumber" + }, + "CrossConnectId": { + "name": "CrossConnectId", + "description": "Port cross connect identifier", + "json_tag": "crossConnectId" + }, + "Ibx": { + "name": "Ibx", + "description": "z-side/Equinix IBX", + "json_tag": "ibx" + }, + "PatchPanel": { + "name": "PatchPanel", + "description": "Port patch panel", + "json_tag": "patchPanel" + }, + "PatchPanelPortA": { + "name": "PatchPanelPortA", + "description": "Port patch panel port A", + "json_tag": "patchPanelPortA" + }, + "PatchPanelPortB": { + "name": "PatchPanelPortB", + "description": "Port patch panel port B", + "json_tag": "patchPanelPortB" + }, + "SystemName": { + "name": "SystemName", + "description": "Port system name", + "json_tag": "systemName" + } + } + }, + "PortV4SearchRequest": { + "type_name": "PortV4SearchRequest", + "description": "PortV4SearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "PrecisionTimeChangeOperation": { + "type_name": "PrecisionTimeChangeOperation", + "description": "PrecisionTimeChangeOperation Fabric Precision Timing change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "new value for updated parameter", + "json_tag": "value" + } + } + }, + "PrecisionTimeOrder": { + "type_name": "PrecisionTimeOrder", + "description": "PrecisionTimeOrder Precision Time Order", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "Customer reference number", + "json_tag": "customerReferenceNumber" + }, + "OrderNumber": { + "name": "OrderNumber", + "description": "Order Reference Number", + "json_tag": "orderNumber" + }, + "PurchaseOrderNumber": { + "name": "PurchaseOrderNumber", + "description": "Purchase order number", + "json_tag": "purchaseOrderNumber" + } + } + }, + "PrecisionTimePackagePostResponse": { + "type_name": "PrecisionTimePackagePostResponse", + "description": "PrecisionTimePackagePostResponse struct for PrecisionTimePackagePostResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + } + } + }, + "PrecisionTimePackageRequest": { + "type_name": "PrecisionTimePackageRequest", + "description": "PrecisionTimePackageRequest Precision Time Service Level Request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + } + } + }, + "PrecisionTimePackageResponse": { + "type_name": "PrecisionTimePackageResponse", + "description": "PrecisionTimePackageResponse EPT Service Package Information", + "fields": { + "AccuracySla": { + "name": "AccuracySla", + "description": "Accuracy SLA for the package code, -1 value denotes the accuracySla is not published.", + "json_tag": "accuracySla" + }, + "AccuracySlaMax": { + "name": "AccuracySlaMax", + "description": "Typical maximum Accuracy for the package code.", + "json_tag": "accuracySlaMax" + }, + "AccuracySlaMin": { + "name": "AccuracySlaMin", + "description": "Typical minimum Accuracy for the package code.", + "json_tag": "accuracySlaMin" + }, + "AccuracySlaUnit": { + "name": "AccuracySlaUnit", + "description": "Accuracy SLA unit.", + "json_tag": "accuracySlaUnit" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Connection bandwidth in Mbps.", + "json_tag": "bandwidth" + }, + "Changelog": { + "name": "Changelog", + "description": "", + "json_tag": "changelog" + }, + "ClientsPerSecondMax": { + "name": "ClientsPerSecondMax", + "description": "Max. number of clients that can be synchronized per second at a packet rate of 1 per second.", + "json_tag": "clientsPerSecondMax" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "MultiSubnetSupported": { + "name": "MultiSubnetSupported", + "description": "Is Multiple subnet supported for the package code.", + "json_tag": "multiSubnetSupported" + }, + "RedundancySupported": { + "name": "RedundancySupported", + "description": "Is Redundant virtual connection supported for the package code.", + "json_tag": "redundancySupported" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "PrecisionTimePrice": { + "type_name": "PrecisionTimePrice", + "description": "PrecisionTimePrice Precision Time Price", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Charges": { + "name": "Charges", + "description": "", + "json_tag": "charges" + }, + "Currency": { + "name": "Currency", + "description": "offering price currency", + "json_tag": "currency" + } + } + }, + "PrecisionTimeServiceConnectionsResponse": { + "type_name": "PrecisionTimeServiceConnectionsResponse", + "description": "PrecisionTimeServiceConnectionsResponse EPT service instance's L2 connections", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "PrecisionTimeServicePackagesResponse": { + "type_name": "PrecisionTimeServicePackagesResponse", + "description": "PrecisionTimeServicePackagesResponse Precision Packages", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "PrecisionTimeServiceRequest": { + "type_name": "PrecisionTimeServiceRequest", + "description": "PrecisionTimeServiceRequest Create Precision Time Service Request Schema.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Connections": { + "name": "Connections", + "description": "", + "json_tag": "connections" + }, + "Ipv4": { + "name": "Ipv4", + "description": "", + "json_tag": "ipv4" + }, + "Name": { + "name": "Name", + "description": "Precision Time Service name.", + "json_tag": "name" + }, + "NtpAdvancedConfiguration": { + "name": "NtpAdvancedConfiguration", + "description": "NTP Advanced configuration - MD5 Authentication.", + "json_tag": "ntpAdvancedConfiguration" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "PtpAdvancedConfiguration": { + "name": "PtpAdvancedConfiguration", + "description": "", + "json_tag": "ptpAdvancedConfiguration" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "PrecisionTimeServiceResponse": { + "type_name": "PrecisionTimeServiceResponse", + "description": "PrecisionTimeServiceResponse Precision Time Service Response Schema.", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Connections": { + "name": "Connections", + "description": "Fabric Connections associated with Precision Time Service.", + "json_tag": "connections" + }, + "Href": { + "name": "Href", + "description": "Precision Time Service URI.", + "json_tag": "href" + }, + "Ipv4": { + "name": "Ipv4", + "description": "", + "json_tag": "ipv4" + }, + "Name": { + "name": "Name", + "description": "Precision Time Service Name.", + "json_tag": "name" + }, + "NtpAdvancedConfiguration": { + "name": "NtpAdvancedConfiguration", + "description": "NTP Advanced configuration - MD5 Authentication.", + "json_tag": "ntpAdvancedConfiguration" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "Order": { + "name": "Order", + "description": "", + "json_tag": "order" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "Pricing": { + "name": "Pricing", + "description": "", + "json_tag": "pricing" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "PtpAdvancedConfiguration": { + "name": "PtpAdvancedConfiguration", + "description": "", + "json_tag": "ptpAdvancedConfiguration" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Precision Time Service UUID.", + "json_tag": "uuid" + } + } + }, + "Price": { + "type_name": "Price", + "description": "Price struct for Price", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Catgory": { + "name": "Catgory", + "description": "", + "json_tag": "catgory" + }, + "Charges": { + "name": "Charges", + "description": "", + "json_tag": "charges" + }, + "Code": { + "name": "Code", + "description": "Equinix-assigned product code", + "json_tag": "code" + }, + "Connection": { + "name": "Connection", + "description": "", + "json_tag": "connection" + }, + "Currency": { + "name": "Currency", + "description": "Product offering price currency", + "json_tag": "currency" + }, + "Description": { + "name": "Description", + "description": "Product description", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "An absolute URL that returns specified pricing data", + "json_tag": "href" + }, + "IpBlock": { + "name": "IpBlock", + "description": "", + "json_tag": "ipBlock" + }, + "Name": { + "name": "Name", + "description": "Full product name", + "json_tag": "name" + }, + "Port": { + "name": "Port", + "description": "", + "json_tag": "port" + }, + "Router": { + "name": "Router", + "description": "", + "json_tag": "router" + }, + "TermLength": { + "name": "TermLength", + "description": "", + "json_tag": "termLength" + }, + "TimeService": { + "name": "TimeService", + "description": "", + "json_tag": "timeService" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "PriceCharge": { + "type_name": "PriceCharge", + "description": "PriceCharge Price Charge", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Price": { + "name": "Price", + "description": "Offering price", + "json_tag": "price" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "PriceError": { + "type_name": "PriceError", + "description": "PriceError Error with details", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CorrelationId": { + "name": "CorrelationId", + "description": "", + "json_tag": "correlationId" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "ErrorCode": { + "name": "ErrorCode", + "description": "", + "json_tag": "errorCode" + }, + "ErrorMessage": { + "name": "ErrorMessage", + "description": "", + "json_tag": "errorMessage" + }, + "Help": { + "name": "Help", + "description": "", + "json_tag": "help" + } + } + }, + "PriceErrorAdditionalInfo": { + "type_name": "PriceErrorAdditionalInfo", + "description": "PriceErrorAdditionalInfo struct for PriceErrorAdditionalInfo", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + }, + "Reason": { + "name": "Reason", + "description": "", + "json_tag": "reason" + } + } + }, + "PriceLocation": { + "type_name": "PriceLocation", + "description": "PriceLocation struct for PriceLocation", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Ibx": { + "name": "Ibx", + "description": "", + "json_tag": "ibx" + }, + "MetroCode": { + "name": "MetroCode", + "description": "", + "json_tag": "metroCode" + } + } + }, + "PriceSearchResponse": { + "type_name": "PriceSearchResponse", + "description": "PriceSearchResponse struct for PriceSearchResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "ProcessStep": { + "type_name": "ProcessStep", + "description": "ProcessStep Definition of customized step while making connection", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Service profile custom step description", + "json_tag": "description" + }, + "SubTitle": { + "name": "SubTitle", + "description": "Service profile custom step sub title", + "json_tag": "subTitle" + }, + "Title": { + "name": "Title", + "description": "Service profile custom step title", + "json_tag": "title" + } + } + }, + "Project": { + "type_name": "Project", + "description": "Project struct for Project", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ProjectId": { + "name": "ProjectId", + "description": "Subscriber-assigned project ID", + "json_tag": "projectId" + } + } + }, + "ProviderResponse": { + "type_name": "ProviderResponse", + "description": "ProviderResponse - Describes the response structure for different orchestrator provider types, including their specific configuration details.", + "fields": { + "AWSProviderResponse": { + "name": "AWSProviderResponse", + "description": "" + }, + "FabricProviderResponse": { + "name": "FabricProviderResponse", + "description": "" + }, + "GCPProviderResponse": { + "name": "GCPProviderResponse", + "description": "" + } + } + }, + "ProvidersSearchResponse": { + "type_name": "ProvidersSearchResponse", + "description": "ProvidersSearchResponse - struct for ProvidersSearchResponse", + "fields": { + "SearchDirectConnect": { + "name": "SearchDirectConnect", + "description": "" + }, + "Subnet": { + "name": "Subnet", + "description": "" + }, + "VPC": { + "name": "VPC", + "description": "" + } + } + }, + "PtpAdvanceConfiguration": { + "type_name": "PtpAdvanceConfiguration", + "description": "PtpAdvanceConfiguration PTP Advanced Configuration.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Domain": { + "name": "Domain", + "description": "The PTP domain value.", + "json_tag": "domain" + }, + "GrantTime": { + "name": "GrantTime", + "description": "Unicast Grant Time in seconds. For Multicast and Hybrid transport modes, grant time defaults to 300 seconds. For Unicast mode, grant time can be between 30 to 7200.", + "json_tag": "grantTime" + }, + "LogAnnounceInterval": { + "name": "LogAnnounceInterval", + "description": "", + "json_tag": "logAnnounceInterval" + }, + "LogDelayReqInterval": { + "name": "LogDelayReqInterval", + "description": "", + "json_tag": "logDelayReqInterval" + }, + "LogSyncInterval": { + "name": "LogSyncInterval", + "description": "", + "json_tag": "logSyncInterval" + }, + "Priority1": { + "name": "Priority1", + "description": "The priority1 value determines the best primary clock, Lower value indicates higher priority.", + "json_tag": "priority1" + }, + "Priority2": { + "name": "Priority2", + "description": "The priority2 value differentiates and prioritizes the primary clock to avoid confusion when priority1-value is the same for different primary clocks in a network.", + "json_tag": "priority2" + }, + "TimeScale": { + "name": "TimeScale", + "description": "", + "json_tag": "timeScale" + }, + "TransportMode": { + "name": "TransportMode", + "description": "", + "json_tag": "transportMode" + } + } + }, + "RemoveOperation": { + "type_name": "RemoveOperation", + "description": "RemoveOperation Remove sub-resource from an existing model", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "A JSON Pointer path.", + "json_tag": "path" + } + } + }, + "ReplaceOperation": { + "type_name": "ReplaceOperation", + "description": "ReplaceOperation Replace attribute value or sub-resource in the existing model", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "A JSON Pointer path.", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "value to replace with", + "json_tag": "value" + } + } + }, + "ResourceData": { + "type_name": "ResourceData", + "description": "ResourceData struct for ResourceData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Cloud Event asset href", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "Cloud Event asset name", + "json_tag": "name" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "State": { + "name": "State", + "description": "Cloud Event asset state", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "Cloud Event asset type", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Cloud Event asset uuid", + "json_tag": "uuid" + } + } + }, + "ResourceSelector": { + "type_name": "ResourceSelector", + "description": "ResourceSelector struct for ResourceSelector", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Include": { + "name": "Include", + "description": "### Supported metric names to use on filters with property /subject: * `/fabric/v4/ports/\u003cuuid\u003e` - port metrics * `/fabric/v4/connections/\u003cuuid\u003e` - connection metrics * `/fabric/v4/metros/\u003cmetroCode\u003e` - metro latency metrics", + "json_tag": "include" + } + } + }, + "ResourceSelectorResponse": { + "type_name": "ResourceSelectorResponse", + "description": "ResourceSelectorResponse struct for ResourceSelectorResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Include": { + "name": "Include", + "description": "### Supported metric names to use on filters with property /subject: * `/fabric/v4/ports/\u003cuuid\u003e` - port metrics * `/fabric/v4/connections/\u003cuuid\u003e` - connection metrics * `/fabric/v4/metros/\u003cmetroCode\u003e` - metro latency metrics", + "json_tag": "include" + } + } + }, + "RouteAggregationChangeData": { + "type_name": "RouteAggregationChangeData", + "description": "RouteAggregationChangeData Current state of latest Route Aggregation change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "Created by User Key", + "json_tag": "createdBy" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Set when change flow starts", + "json_tag": "createdDateTime" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Href": { + "name": "Href", + "description": "Route AGGREGATION Change URI", + "json_tag": "href" + }, + "Information": { + "name": "Information", + "description": "Additional information", + "json_tag": "information" + }, + "Status": { + "name": "Status", + "description": "Current outcome of the change flow", + "json_tag": "status" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedBy": { + "name": "UpdatedBy", + "description": "Updated by User Key", + "json_tag": "updatedBy" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "Set when change object is updated", + "json_tag": "updatedDateTime" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "RouteAggregationChangeDataResponse": { + "type_name": "RouteAggregationChangeDataResponse", + "description": "RouteAggregationChangeDataResponse List of Route Aggregation changes", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "RouteAggregationConnectionsData": { + "type_name": "RouteAggregationConnectionsData", + "description": "RouteAggregationConnectionsData struct for RouteAggregationConnectionsData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Connection URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Route Aggregation identifier", + "json_tag": "uuid" + } + } + }, + "RouteAggregationRulesBase": { + "type_name": "RouteAggregationRulesBase", + "description": "RouteAggregationRulesBase struct for RouteAggregationRulesBase", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Customer-provided Route Aggregation Rule description", + "json_tag": "description" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Prefix": { + "name": "Prefix", + "description": "", + "json_tag": "prefix" + } + } + }, + "RouteAggregationRulesChange": { + "type_name": "RouteAggregationRulesChange", + "description": "RouteAggregationRulesChange Current state of latest Route Aggregation Rule change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Route Aggregation Change URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "RouteAggregationRulesChangeData": { + "type_name": "RouteAggregationRulesChangeData", + "description": "RouteAggregationRulesChangeData Current state of latest Route Aggregation Rules change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "Created by User Key", + "json_tag": "createdBy" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Set when change flow starts", + "json_tag": "createdDateTime" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Href": { + "name": "Href", + "description": "Route Aggregation Change URI", + "json_tag": "href" + }, + "Status": { + "name": "Status", + "description": "Current outcome of the change flow", + "json_tag": "status" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedBy": { + "name": "UpdatedBy", + "description": "Updated by User Key", + "json_tag": "updatedBy" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "Set when change object is updated", + "json_tag": "updatedDateTime" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "RouteAggregationRulesChangeDataResponse": { + "type_name": "RouteAggregationRulesChangeDataResponse", + "description": "RouteAggregationRulesChangeDataResponse List of Route Aggregation Rule changes", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "RouteAggregationRulesChangeOperation": { + "type_name": "RouteAggregationRulesChangeOperation", + "description": "RouteAggregationRulesChangeOperation Route Aggregation Rule change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path inside document leading to updated parameter", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "", + "json_tag": "value" + } + } + }, + "RouteAggregationRulesData": { + "type_name": "RouteAggregationRulesData", + "description": "RouteAggregationRulesData struct for RouteAggregationRulesData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Description": { + "name": "Description", + "description": "Customer-provided Route Aggregation Rule description", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Route Aggregation Rules URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Prefix": { + "name": "Prefix", + "description": "", + "json_tag": "prefix" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Route Aggregation Rule identifier", + "json_tag": "uuid" + } + } + }, + "RouteAggregationRulesPatchRequestItem": { + "type_name": "RouteAggregationRulesPatchRequestItem", + "description": "RouteAggregationRulesPatchRequestItem Route Aggregation Rule change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "Handy shortcut for operation name", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path to change", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "new value for updated parameter", + "json_tag": "value" + } + } + }, + "RouteAggregationRulesPostRequest": { + "type_name": "RouteAggregationRulesPostRequest", + "description": "RouteAggregationRulesPostRequest Create Route Aggregation Rule POST request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Route Aggregation Rule configuration", + "json_tag": "data" + } + } + }, + "RouteAggregationSortItem": { + "type_name": "RouteAggregationSortItem", + "description": "RouteAggregationSortItem struct for RouteAggregationSortItem", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "RouteAggregationsBase": { + "type_name": "RouteAggregationsBase", + "description": "RouteAggregationsBase struct for RouteAggregationsBase", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Customer-provided connection description", + "json_tag": "description" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "RouteAggregationsChange": { + "type_name": "RouteAggregationsChange", + "description": "RouteAggregationsChange Current state of latest Route Aggregation change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Route AGGREGATION Change URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "RouteAggregationsChangeOperation": { + "type_name": "RouteAggregationsChangeOperation", + "description": "RouteAggregationsChangeOperation Route Aggregation change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path inside document leading to updated parameter", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "", + "json_tag": "value" + } + } + }, + "RouteAggregationsData": { + "type_name": "RouteAggregationsData", + "description": "RouteAggregationsData struct for RouteAggregationsData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "ConnectionsCount": { + "name": "ConnectionsCount", + "description": "", + "json_tag": "connectionsCount" + }, + "Description": { + "name": "Description", + "description": "Customer-provided connection description", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Route Aggregation URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "RulesCount": { + "name": "RulesCount", + "description": "", + "json_tag": "rulesCount" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Route Aggregation identifier", + "json_tag": "uuid" + } + } + }, + "RouteAggregationsDataProject": { + "type_name": "RouteAggregationsDataProject", + "description": "RouteAggregationsDataProject struct for RouteAggregationsDataProject", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Project URI", + "json_tag": "href" + }, + "ProjectId": { + "name": "ProjectId", + "description": "Subscriber-assigned project ID", + "json_tag": "projectId" + } + } + }, + "RouteAggregationsPatchRequestItem": { + "type_name": "RouteAggregationsPatchRequestItem", + "description": "RouteAggregationsPatchRequestItem Route Aggregation change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "Handy shortcut for operation name", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path to change", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "new value for updated parameter", + "json_tag": "value" + } + } + }, + "RouteAggregationsSearchBase": { + "type_name": "RouteAggregationsSearchBase", + "description": "RouteAggregationsSearchBase struct for RouteAggregationsSearchBase", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "RouteAggregationsSearchBaseFilter": { + "type_name": "RouteAggregationsSearchBaseFilter", + "description": "RouteAggregationsSearchBaseFilter struct for RouteAggregationsSearchBaseFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "RouteAggregationsSearchFilterItem": { + "type_name": "RouteAggregationsSearchFilterItem", + "description": "RouteAggregationsSearchFilterItem struct for RouteAggregationsSearchFilterItem", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "RouteAggregationsSearchResponse": { + "type_name": "RouteAggregationsSearchResponse", + "description": "RouteAggregationsSearchResponse struct for RouteAggregationsSearchResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of Route Aggregations", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "RouteFilterChangeData": { + "type_name": "RouteFilterChangeData", + "description": "RouteFilterChangeData Current state of latest route filter change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "Created by user key", + "json_tag": "createdBy" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Set when change flow starts", + "json_tag": "createdDateTime" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Href": { + "name": "Href", + "description": "Route filter change URI", + "json_tag": "href" + }, + "Information": { + "name": "Information", + "description": "Additional information", + "json_tag": "information" + }, + "Status": { + "name": "Status", + "description": "Current outcome of the change flow", + "json_tag": "status" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedBy": { + "name": "UpdatedBy", + "description": "Updated by user key", + "json_tag": "updatedBy" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "Set when change object is updated", + "json_tag": "updatedDateTime" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "RouteFilterChangeDataResponse": { + "type_name": "RouteFilterChangeDataResponse", + "description": "RouteFilterChangeDataResponse List of route filter changes", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "RouteFilterConnectionsData": { + "type_name": "RouteFilterConnectionsData", + "description": "RouteFilterConnectionsData struct for RouteFilterConnectionsData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Connection URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Route filter identifier", + "json_tag": "uuid" + } + } + }, + "RouteFilterRulesBase": { + "type_name": "RouteFilterRulesBase", + "description": "RouteFilterRulesBase struct for RouteFilterRulesBase", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Customer-provided Route Filter Rule description", + "json_tag": "description" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Prefix": { + "name": "Prefix", + "description": "", + "json_tag": "prefix" + }, + "PrefixMatch": { + "name": "PrefixMatch", + "description": "", + "json_tag": "prefixMatch" + } + } + }, + "RouteFilterRulesChange": { + "type_name": "RouteFilterRulesChange", + "description": "RouteFilterRulesChange Current state of latest route filter rule change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Route Filter Change URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "RouteFilterRulesChangeData": { + "type_name": "RouteFilterRulesChangeData", + "description": "RouteFilterRulesChangeData Current state of latest route filter rules change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "Created by User Key", + "json_tag": "createdBy" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Set when change flow starts", + "json_tag": "createdDateTime" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Href": { + "name": "Href", + "description": "Route Filter Change URI", + "json_tag": "href" + }, + "Status": { + "name": "Status", + "description": "Current outcome of the change flow", + "json_tag": "status" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedBy": { + "name": "UpdatedBy", + "description": "Updated by User Key", + "json_tag": "updatedBy" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "Set when change object is updated", + "json_tag": "updatedDateTime" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "RouteFilterRulesChangeDataResponse": { + "type_name": "RouteFilterRulesChangeDataResponse", + "description": "RouteFilterRulesChangeDataResponse List of route filter rule changes", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "RouteFilterRulesChangeOperation": { + "type_name": "RouteFilterRulesChangeOperation", + "description": "RouteFilterRulesChangeOperation Route filter rule change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path inside document leading to updated parameter", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "", + "json_tag": "value" + } + } + }, + "RouteFilterRulesData": { + "type_name": "RouteFilterRulesData", + "description": "RouteFilterRulesData struct for RouteFilterRulesData", + "fields": { + "Action": { + "name": "Action", + "description": "", + "json_tag": "action" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "Changelog": { + "name": "Changelog", + "description": "", + "json_tag": "changelog" + }, + "Description": { + "name": "Description", + "description": "Customer-provided Route Filter Rule description", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Route Filter Rules URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Prefix": { + "name": "Prefix", + "description": "", + "json_tag": "prefix" + }, + "PrefixMatch": { + "name": "PrefixMatch", + "description": "prefix matching operator", + "json_tag": "prefixMatch" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Route Filter Rule identifier", + "json_tag": "uuid" + } + } + }, + "RouteFilterRulesPatchRequestItem": { + "type_name": "RouteFilterRulesPatchRequestItem", + "description": "RouteFilterRulesPatchRequestItem Route filter rule change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "Handy shortcut for operation name", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path to change", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "new value for updated parameter", + "json_tag": "value" + } + } + }, + "RouteFilterRulesPostRequest": { + "type_name": "RouteFilterRulesPostRequest", + "description": "RouteFilterRulesPostRequest Create Route Filter Rule POST request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Route Filter Rule configuration", + "json_tag": "data" + } + } + }, + "RouteFiltersBase": { + "type_name": "RouteFiltersBase", + "description": "RouteFiltersBase struct for RouteFiltersBase", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Customer-provided connection description", + "json_tag": "description" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "RouteFiltersChange": { + "type_name": "RouteFiltersChange", + "description": "RouteFiltersChange Current state of latest route filter change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Route filter change URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "RouteFiltersChangeOperation": { + "type_name": "RouteFiltersChangeOperation", + "description": "RouteFiltersChangeOperation Route filter change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path inside document leading to updated parameter", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "", + "json_tag": "value" + } + } + }, + "RouteFiltersData": { + "type_name": "RouteFiltersData", + "description": "RouteFiltersData struct for RouteFiltersData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "Changelog": { + "name": "Changelog", + "description": "", + "json_tag": "changelog" + }, + "ConnectionsCount": { + "name": "ConnectionsCount", + "description": "", + "json_tag": "connectionsCount" + }, + "Description": { + "name": "Description", + "description": "Customer-provided connection description", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Route filter URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "NotMatchedRuleAction": { + "name": "NotMatchedRuleAction", + "description": "", + "json_tag": "notMatchedRuleAction" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "RulesCount": { + "name": "RulesCount", + "description": "", + "json_tag": "rulesCount" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Route filter identifier", + "json_tag": "uuid" + } + } + }, + "RouteFiltersDataProject": { + "type_name": "RouteFiltersDataProject", + "description": "RouteFiltersDataProject struct for RouteFiltersDataProject", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Project URI", + "json_tag": "href" + }, + "ProjectId": { + "name": "ProjectId", + "description": "Subscriber-assigned project ID", + "json_tag": "projectId" + } + } + }, + "RouteFiltersPatchRequestItem": { + "type_name": "RouteFiltersPatchRequestItem", + "description": "RouteFiltersPatchRequestItem Route filter change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "Handy shortcut for operation name", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path to change", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "new value for updated parameter", + "json_tag": "value" + } + } + }, + "RouteFiltersSearchBase": { + "type_name": "RouteFiltersSearchBase", + "description": "RouteFiltersSearchBase struct for RouteFiltersSearchBase", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "RouteFiltersSearchBaseFilter": { + "type_name": "RouteFiltersSearchBaseFilter", + "description": "RouteFiltersSearchBaseFilter struct for RouteFiltersSearchBaseFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "RouteFiltersSearchFilterItem": { + "type_name": "RouteFiltersSearchFilterItem", + "description": "RouteFiltersSearchFilterItem struct for RouteFiltersSearchFilterItem", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "RouteFiltersSearchResponse": { + "type_name": "RouteFiltersSearchResponse", + "description": "RouteFiltersSearchResponse struct for RouteFiltersSearchResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of route filters", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "RouteTableEntry": { + "type_name": "RouteTableEntry", + "description": "RouteTableEntry Route table entry object", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AsPath": { + "name": "AsPath", + "description": "", + "json_tag": "asPath" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Connection": { + "name": "Connection", + "description": "", + "json_tag": "connection" + }, + "LocalPreference": { + "name": "LocalPreference", + "description": "", + "json_tag": "localPreference" + }, + "MED": { + "name": "MED", + "description": "", + "json_tag": "MED" + }, + "NextHop": { + "name": "NextHop", + "description": "", + "json_tag": "nextHop" + }, + "Prefix": { + "name": "Prefix", + "description": "", + "json_tag": "prefix" + }, + "ProtocolType": { + "name": "ProtocolType", + "description": "", + "json_tag": "protocolType" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "RouteTableEntryConnection": { + "type_name": "RouteTableEntryConnection", + "description": "RouteTableEntryConnection struct for RouteTableEntryConnection", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "RouteTableEntryFilter": { + "type_name": "RouteTableEntryFilter", + "description": "RouteTableEntryFilter struct for RouteTableEntryFilter", + "fields": { + "RouteTableEntryOrFilter": { + "name": "RouteTableEntryOrFilter", + "description": "" + }, + "RouteTableEntrySimpleExpression": { + "name": "RouteTableEntrySimpleExpression", + "description": "" + } + } + }, + "RouteTableEntryFilters": { + "type_name": "RouteTableEntryFilters", + "description": "RouteTableEntryFilters struct for RouteTableEntryFilters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "RouteTableEntryOrFilter": { + "type_name": "RouteTableEntryOrFilter", + "description": "RouteTableEntryOrFilter struct for RouteTableEntryOrFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + } + } + }, + "RouteTableEntrySearchRequest": { + "type_name": "RouteTableEntrySearchRequest", + "description": "RouteTableEntrySearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "RouteTableEntrySearchResponse": { + "type_name": "RouteTableEntrySearchResponse", + "description": "RouteTableEntrySearchResponse struct for RouteTableEntrySearchResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "RouteTableEntrySimpleExpression": { + "type_name": "RouteTableEntrySimpleExpression", + "description": "RouteTableEntrySimpleExpression struct for RouteTableEntrySimpleExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Possible operators to use on filters: * `=` - equal * `!=` - not equal * `\u003e` - greater than * `\u003e=` - greater than or equal to * `\u003c` - less than * `\u003c=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `~*` - case-insensitive like", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Possible field names to use on filters: * `/type` - Route table entry type * `/prefix` - Route table entry prefix * `/nextHop` - Route table entry nextHop * `/state` - Route table entry state * `/MED` - Route table entry med * `/_*` - all-category search", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "RouteTableEntrySortCriteria": { + "type_name": "RouteTableEntrySortCriteria", + "description": "RouteTableEntrySortCriteria struct for RouteTableEntrySortCriteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "RouterActionsConnection": { + "type_name": "RouterActionsConnection", + "description": "RouterActionsConnection Connection object for router actions", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Connection UUID", + "json_tag": "uuid" + } + } + }, + "RouterActionsRouter": { + "type_name": "RouterActionsRouter", + "description": "RouterActionsRouter Router object for router actions", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Router UUID", + "json_tag": "uuid" + } + } + }, + "RoutingProtocolBFD": { + "type_name": "RoutingProtocolBFD", + "description": "RoutingProtocolBFD struct for RoutingProtocolBFD", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Enabled": { + "name": "Enabled", + "description": "", + "json_tag": "enabled" + }, + "Interval": { + "name": "Interval", + "description": "", + "json_tag": "interval" + } + } + }, + "RoutingProtocolBGPData": { + "type_name": "RoutingProtocolBGPData", + "description": "RoutingProtocolBGPData struct for RoutingProtocolBGPData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AsOverrideEnabled": { + "name": "AsOverrideEnabled", + "description": "Enable AS number override", + "json_tag": "asOverrideEnabled" + }, + "Bfd": { + "name": "Bfd", + "description": "", + "json_tag": "bfd" + }, + "BgpAuthKey": { + "name": "BgpAuthKey", + "description": "BGP authorization key", + "json_tag": "bgpAuthKey" + }, + "BgpIpv4": { + "name": "BgpIpv4", + "description": "", + "json_tag": "bgpIpv4" + }, + "BgpIpv6": { + "name": "BgpIpv6", + "description": "", + "json_tag": "bgpIpv6" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "Changelog": { + "name": "Changelog", + "description": "", + "json_tag": "changelog" + }, + "CustomerAsn": { + "name": "CustomerAsn", + "description": "Customer asn", + "json_tag": "customerAsn" + }, + "EquinixAsn": { + "name": "EquinixAsn", + "description": "Equinix asn", + "json_tag": "equinixAsn" + }, + "Href": { + "name": "Href", + "description": "Routing Protocol URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Routing protocol identifier", + "json_tag": "uuid" + } + } + }, + "RoutingProtocolBGPType": { + "type_name": "RoutingProtocolBGPType", + "description": "RoutingProtocolBGPType struct for RoutingProtocolBGPType", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AsOverrideEnabled": { + "name": "AsOverrideEnabled", + "description": "Enable AS number override", + "json_tag": "asOverrideEnabled" + }, + "Bfd": { + "name": "Bfd", + "description": "", + "json_tag": "bfd" + }, + "BgpAuthKey": { + "name": "BgpAuthKey", + "description": "BGP authorization key", + "json_tag": "bgpAuthKey" + }, + "BgpIpv4": { + "name": "BgpIpv4", + "description": "", + "json_tag": "bgpIpv4" + }, + "BgpIpv6": { + "name": "BgpIpv6", + "description": "", + "json_tag": "bgpIpv6" + }, + "CustomerAsn": { + "name": "CustomerAsn", + "description": "Customer asn", + "json_tag": "customerAsn" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "RoutingProtocolBase": { + "type_name": "RoutingProtocolBase", + "description": "RoutingProtocolBase - struct for RoutingProtocolBase", + "fields": { + "RoutingProtocolBGPType": { + "name": "RoutingProtocolBGPType", + "description": "" + }, + "RoutingProtocolDirectType": { + "name": "RoutingProtocolDirectType", + "description": "" + } + } + }, + "RoutingProtocolChange": { + "type_name": "RoutingProtocolChange", + "description": "RoutingProtocolChange Current state of latest Routing Protocol change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Routing Protocol Change URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "RoutingProtocolChangeData": { + "type_name": "RoutingProtocolChangeData", + "description": "RoutingProtocolChangeData Current state of latest Routing Protocol change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "Created by User Key", + "json_tag": "createdBy" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Set when change flow starts", + "json_tag": "createdDateTime" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Href": { + "name": "Href", + "description": "Routing Protocol Change URI", + "json_tag": "href" + }, + "Information": { + "name": "Information", + "description": "Additional information", + "json_tag": "information" + }, + "Status": { + "name": "Status", + "description": "Current outcome of the change flow", + "json_tag": "status" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedBy": { + "name": "UpdatedBy", + "description": "Updated by User Key", + "json_tag": "updatedBy" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "Set when change object is updated", + "json_tag": "updatedDateTime" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "RoutingProtocolChangeDataResponse": { + "type_name": "RoutingProtocolChangeDataResponse", + "description": "RoutingProtocolChangeDataResponse List of network changes", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "RoutingProtocolChangeOperation": { + "type_name": "RoutingProtocolChangeOperation", + "description": "RoutingProtocolChangeOperation Routing Protocol change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path inside document leading to updated parameter", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "", + "json_tag": "value" + } + } + }, + "RoutingProtocolData": { + "type_name": "RoutingProtocolData", + "description": "RoutingProtocolData - struct for RoutingProtocolData", + "fields": { + "RoutingProtocolBGPData": { + "name": "RoutingProtocolBGPData", + "description": "" + }, + "RoutingProtocolDirectData": { + "name": "RoutingProtocolDirectData", + "description": "" + } + } + }, + "RoutingProtocolDirectData": { + "type_name": "RoutingProtocolDirectData", + "description": "RoutingProtocolDirectData struct for RoutingProtocolDirectData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "Changelog": { + "name": "Changelog", + "description": "", + "json_tag": "changelog" + }, + "DirectIpv4": { + "name": "DirectIpv4", + "description": "", + "json_tag": "directIpv4" + }, + "DirectIpv6": { + "name": "DirectIpv6", + "description": "", + "json_tag": "directIpv6" + }, + "Href": { + "name": "Href", + "description": "Routing Protocol URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Routing protocol identifier", + "json_tag": "uuid" + } + } + }, + "RoutingProtocolDirectType": { + "type_name": "RoutingProtocolDirectType", + "description": "RoutingProtocolDirectType struct for RoutingProtocolDirectType", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DirectIpv4": { + "name": "DirectIpv4", + "description": "", + "json_tag": "directIpv4" + }, + "DirectIpv6": { + "name": "DirectIpv6", + "description": "", + "json_tag": "directIpv6" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "RoutingProtocolOperation": { + "type_name": "RoutingProtocolOperation", + "description": "RoutingProtocolOperation struct for RoutingProtocolOperation", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Errors": { + "name": "Errors", + "description": "", + "json_tag": "errors" + } + } + }, + "SearchDirectConnect": { + "type_name": "SearchDirectConnect", + "description": "SearchDirectConnect struct for SearchDirectConnect", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "SearchExpression": { + "type_name": "SearchExpression", + "description": "SearchExpression struct for SearchExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + }, + "Operator": { + "name": "Operator", + "description": "", + "json_tag": "operator" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "SearchRequest": { + "type_name": "SearchRequest", + "description": "SearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "SearchResponse": { + "type_name": "SearchResponse", + "description": "SearchResponse struct for SearchResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "ServerConfiguration": { + "type_name": "ServerConfiguration", + "description": "ServerConfiguration stores the information about a server", + "fields": { + "Description": { + "name": "Description", + "description": "" + }, + "URL": { + "name": "URL", + "description": "" + }, + "Variables": { + "name": "Variables", + "description": "" + } + } + }, + "ServerVariable": { + "type_name": "ServerVariable", + "description": "ServerVariable stores the information about a server variable", + "fields": { + "DefaultValue": { + "name": "DefaultValue", + "description": "" + }, + "Description": { + "name": "Description", + "description": "" + }, + "EnumValues": { + "name": "EnumValues", + "description": "" + } + } + }, + "ServiceMetro": { + "type_name": "ServiceMetro", + "description": "ServiceMetro struct for ServiceMetro", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "metro code", + "json_tag": "code" + }, + "DisplayName": { + "name": "DisplayName", + "description": "service metro display name", + "json_tag": "displayName" + }, + "Ibxs": { + "name": "Ibxs", + "description": "", + "json_tag": "ibxs" + }, + "InTrail": { + "name": "InTrail", + "description": "", + "json_tag": "inTrail" + }, + "Name": { + "name": "Name", + "description": "metro name", + "json_tag": "name" + }, + "SellerRegions": { + "name": "SellerRegions", + "description": "", + "json_tag": "sellerRegions" + }, + "VcBandwidthMax": { + "name": "VcBandwidthMax", + "description": "max VC speed supported in Mbps", + "json_tag": "vcBandwidthMax" + } + } + }, + "ServiceMetros": { + "type_name": "ServiceMetros", + "description": "ServiceMetros Service Profile Metros", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "ServiceProfile": { + "type_name": "ServiceProfile", + "description": "ServiceProfile Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.", + "fields": { + "AccessPointTypeConfigs": { + "name": "AccessPointTypeConfigs", + "description": "", + "json_tag": "accessPointTypeConfigs" + }, + "Account": { + "name": "Account", + "description": "Seller Account for Service Profile.", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AllowedEmails": { + "name": "AllowedEmails", + "description": "", + "json_tag": "allowedEmails" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "Seller Account for Service Profile.", + "json_tag": "changeLog" + }, + "CustomFields": { + "name": "CustomFields", + "description": "", + "json_tag": "customFields" + }, + "Description": { + "name": "Description", + "description": "User-provided service description should be of maximum length 375", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Service Profile URI response attribute", + "json_tag": "href" + }, + "MarketingInfo": { + "name": "MarketingInfo", + "description": "", + "json_tag": "marketingInfo" + }, + "Metros": { + "name": "Metros", + "description": "Derived response attribute.", + "json_tag": "metros" + }, + "Name": { + "name": "Name", + "description": "Customer-assigned service profile name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Recipients of notifications on service profile change", + "json_tag": "notifications" + }, + "Ports": { + "name": "Ports", + "description": "", + "json_tag": "ports" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "ProjectId": { + "name": "ProjectId", + "description": "", + "json_tag": "projectId" + }, + "SelfProfile": { + "name": "SelfProfile", + "description": "response attribute indicates whether the profile belongs to the same organization as the api-invoker.", + "json_tag": "selfProfile" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned service profile identifier", + "json_tag": "uuid" + }, + "VirtualDevices": { + "name": "VirtualDevices", + "description": "", + "json_tag": "virtualDevices" + }, + "Visibility": { + "name": "Visibility", + "description": "", + "json_tag": "visibility" + } + } + }, + "ServiceProfileAccessPointCOLO": { + "type_name": "ServiceProfileAccessPointCOLO", + "description": "ServiceProfileAccessPointCOLO Colo Access Point", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CrossConnectId": { + "name": "CrossConnectId", + "description": "", + "json_tag": "crossConnectId" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "SellerRegion": { + "name": "SellerRegion", + "description": "", + "json_tag": "sellerRegion" + }, + "SellerRegionDescription": { + "name": "SellerRegionDescription", + "description": "", + "json_tag": "sellerRegionDescription" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "ServiceProfileAccessPointType": { + "type_name": "ServiceProfileAccessPointType", + "description": "ServiceProfileAccessPointType - Access Point Type", + "fields": { + "ServiceProfileAccessPointTypeCOLO": { + "name": "ServiceProfileAccessPointTypeCOLO", + "description": "" + }, + "ServiceProfileAccessPointTypeVD": { + "name": "ServiceProfileAccessPointTypeVD", + "description": "" + } + } + }, + "ServiceProfileAccessPointTypeCOLO": { + "type_name": "ServiceProfileAccessPointTypeCOLO", + "description": "ServiceProfileAccessPointTypeCOLO Colo Access Point Type", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AllowBandwidthAutoApproval": { + "name": "AllowBandwidthAutoApproval", + "description": "Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.", + "json_tag": "allowBandwidthAutoApproval" + }, + "AllowBandwidthUpgrade": { + "name": "AllowBandwidthUpgrade", + "description": "Availability of a bandwidth upgrade. The default is false.", + "json_tag": "allowBandwidthUpgrade" + }, + "AllowCustomBandwidth": { + "name": "AllowCustomBandwidth", + "description": "Setting to enable or disable the ability of the buyer to customize the bandwidth.", + "json_tag": "allowCustomBandwidth" + }, + "AllowRemoteConnections": { + "name": "AllowRemoteConnections", + "description": "Setting to allow or prohibit remote connections to the service profile.", + "json_tag": "allowRemoteConnections" + }, + "ApiConfig": { + "name": "ApiConfig", + "description": "", + "json_tag": "apiConfig" + }, + "AuthenticationKey": { + "name": "AuthenticationKey", + "description": "", + "json_tag": "authenticationKey" + }, + "BandwidthAlertThreshold": { + "name": "BandwidthAlertThreshold", + "description": "percentage of port bandwidth at which an allocation alert is generated - missing on wiki.", + "json_tag": "bandwidthAlertThreshold" + }, + "ConnectionLabel": { + "name": "ConnectionLabel", + "description": "custom name for \\\"Connection\\\"", + "json_tag": "connectionLabel" + }, + "ConnectionRedundancyRequired": { + "name": "ConnectionRedundancyRequired", + "description": "Mandate redundant connections", + "json_tag": "connectionRedundancyRequired" + }, + "EnableAutoGenerateServiceKey": { + "name": "EnableAutoGenerateServiceKey", + "description": "for verizon only.", + "json_tag": "enableAutoGenerateServiceKey" + }, + "LinkProtocolConfig": { + "name": "LinkProtocolConfig", + "description": "", + "json_tag": "linkProtocolConfig" + }, + "Metadata": { + "name": "Metadata", + "description": "", + "json_tag": "metadata" + }, + "SelectiveRedundancy": { + "name": "SelectiveRedundancy", + "description": "Optional redundant connections", + "json_tag": "selectiveRedundancy" + }, + "SupportedBandwidths": { + "name": "SupportedBandwidths", + "description": "", + "json_tag": "supportedBandwidths" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "ServiceProfileAccessPointTypeVD": { + "type_name": "ServiceProfileAccessPointTypeVD", + "description": "ServiceProfileAccessPointTypeVD VirtualDevice Access Point Type", + "fields": { + "AllowCustomBandwidth": { + "name": "AllowCustomBandwidth", + "description": "", + "json_tag": "allowCustomBandwidth" + }, + "AllowRemoteConnections": { + "name": "AllowRemoteConnections", + "description": "Allow remote connections to Service Profile", + "json_tag": "allowRemoteConnections" + }, + "SupportedBandwidths": { + "name": "SupportedBandwidths", + "description": "", + "json_tag": "supportedBandwidths" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "ServiceProfileAccessPointVD": { + "type_name": "ServiceProfileAccessPointVD", + "description": "ServiceProfileAccessPointVD Virtual Device Point", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "InterfaceUuid": { + "name": "InterfaceUuid", + "description": "", + "json_tag": "interfaceUuid" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "ServiceProfileAndFilter": { + "type_name": "ServiceProfileAndFilter", + "description": "ServiceProfileAndFilter struct for ServiceProfileAndFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "ServiceProfileFilter": { + "type_name": "ServiceProfileFilter", + "description": "ServiceProfileFilter struct for ServiceProfileFilter", + "fields": { + "ServiceProfileAndFilter": { + "name": "ServiceProfileAndFilter", + "description": "" + }, + "ServiceProfileSimpleExpression": { + "name": "ServiceProfileSimpleExpression", + "description": "" + } + } + }, + "ServiceProfileLinkProtocolConfig": { + "type_name": "ServiceProfileLinkProtocolConfig", + "description": "ServiceProfileLinkProtocolConfig Configuration for dot1q to qinq translation support", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Encapsulation": { + "name": "Encapsulation", + "description": "", + "json_tag": "encapsulation" + }, + "EncapsulationStrategy": { + "name": "EncapsulationStrategy", + "description": "", + "json_tag": "encapsulationStrategy" + }, + "NamedTags": { + "name": "NamedTags", + "description": "", + "json_tag": "namedTags" + }, + "ReuseVlanSTag": { + "name": "ReuseVlanSTag", + "description": "", + "json_tag": "reuseVlanSTag" + }, + "VlanCTagLabel": { + "name": "VlanCTagLabel", + "description": "was ctagLabel", + "json_tag": "vlanCTagLabel" + } + } + }, + "ServiceProfileMetadata": { + "type_name": "ServiceProfileMetadata", + "description": "ServiceProfileMetadata Metadata. Response attribute. Ignored on request payload.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AllowSecondaryLocation": { + "name": "AllowSecondaryLocation", + "description": "", + "json_tag": "allowSecondaryLocation" + }, + "AllowVcMigration": { + "name": "AllowVcMigration", + "description": "", + "json_tag": "allowVcMigration" + }, + "ConnectionEditable": { + "name": "ConnectionEditable", + "description": "", + "json_tag": "connectionEditable" + }, + "ConnectionNameEditable": { + "name": "ConnectionNameEditable", + "description": "", + "json_tag": "connectionNameEditable" + }, + "EqxManagedPort": { + "name": "EqxManagedPort", + "description": "", + "json_tag": "eqxManagedPort" + }, + "GlobalOrganization": { + "name": "GlobalOrganization", + "description": "", + "json_tag": "globalOrganization" + }, + "LimitAuthKeyConn": { + "name": "LimitAuthKeyConn", + "description": "", + "json_tag": "limitAuthKeyConn" + }, + "MaxConnectionsOnPort": { + "name": "MaxConnectionsOnPort", + "description": "", + "json_tag": "maxConnectionsOnPort" + }, + "MaxDot1q": { + "name": "MaxDot1q", + "description": "", + "json_tag": "maxDot1q" + }, + "MaxQinq": { + "name": "MaxQinq", + "description": "", + "json_tag": "maxQinq" + }, + "PortAssignmentStrategy": { + "name": "PortAssignmentStrategy", + "description": "", + "json_tag": "portAssignmentStrategy" + }, + "Props": { + "name": "Props", + "description": "", + "json_tag": "props" + }, + "RedundantProfileId": { + "name": "RedundantProfileId", + "description": "", + "json_tag": "redundantProfileId" + }, + "RegEx": { + "name": "RegEx", + "description": "", + "json_tag": "regEx" + }, + "RegExMsg": { + "name": "RegExMsg", + "description": "", + "json_tag": "regExMsg" + }, + "ReleaseVlan": { + "name": "ReleaseVlan", + "description": "", + "json_tag": "releaseVlan" + }, + "VariableBilling": { + "name": "VariableBilling", + "description": "", + "json_tag": "variableBilling" + }, + "VlanRangeMaxValue": { + "name": "VlanRangeMaxValue", + "description": "", + "json_tag": "vlanRangeMaxValue" + }, + "VlanRangeMinValue": { + "name": "VlanRangeMinValue", + "description": "", + "json_tag": "vlanRangeMinValue" + } + } + }, + "ServiceProfileRequest": { + "type_name": "ServiceProfileRequest", + "description": "ServiceProfileRequest Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.", + "fields": { + "AccessPointTypeConfigs": { + "name": "AccessPointTypeConfigs", + "description": "", + "json_tag": "accessPointTypeConfigs" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AllowedEmails": { + "name": "AllowedEmails", + "description": "", + "json_tag": "allowedEmails" + }, + "CustomFields": { + "name": "CustomFields", + "description": "", + "json_tag": "customFields" + }, + "Description": { + "name": "Description", + "description": "User-provided service description should be of maximum length 375", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Service Profile URI response attribute", + "json_tag": "href" + }, + "MarketingInfo": { + "name": "MarketingInfo", + "description": "", + "json_tag": "marketingInfo" + }, + "Metros": { + "name": "Metros", + "description": "Derived response attribute.", + "json_tag": "metros" + }, + "Name": { + "name": "Name", + "description": "Customer-assigned service profile name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Recipients of notifications on service profile change", + "json_tag": "notifications" + }, + "Ports": { + "name": "Ports", + "description": "", + "json_tag": "ports" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "ProjectId": { + "name": "ProjectId", + "description": "", + "json_tag": "projectId" + }, + "SelfProfile": { + "name": "SelfProfile", + "description": "response attribute indicates whether the profile belongs to the same organization as the api-invoker.", + "json_tag": "selfProfile" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned service profile identifier", + "json_tag": "uuid" + }, + "VirtualDevices": { + "name": "VirtualDevices", + "description": "", + "json_tag": "virtualDevices" + }, + "Visibility": { + "name": "Visibility", + "description": "", + "json_tag": "visibility" + } + } + }, + "ServiceProfileSearchRequest": { + "type_name": "ServiceProfileSearchRequest", + "description": "ServiceProfileSearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "ServiceProfileSimpleExpression": { + "type_name": "ServiceProfileSimpleExpression", + "description": "ServiceProfileSimpleExpression struct for ServiceProfileSimpleExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Possible operators to use on filters: * `=` - equal", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Possible field names to use on filters: * `/name` - Service Profile name * `/uuid` - Service Profile uuid * `/state` - Service Profile status * `/metros/code` - Service Profile metro code * `/visibility` - Service Profile package * `/type` - Service Profile package * `/project/projectId` - Service Profile project id", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "ServiceProfileSortCriteria": { + "type_name": "ServiceProfileSortCriteria", + "description": "ServiceProfileSortCriteria struct for ServiceProfileSortCriteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "ServiceProfiles": { + "type_name": "ServiceProfiles", + "description": "ServiceProfiles Service Profiles", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "ServiceSearchResponse": { + "type_name": "ServiceSearchResponse", + "description": "ServiceSearchResponse struct for ServiceSearchResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "Data returned from the API call.", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "ServiceToken": { + "type_name": "ServiceToken", + "description": "ServiceToken Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Changelog": { + "name": "Changelog", + "description": "", + "json_tag": "changelog" + }, + "Connection": { + "name": "Connection", + "description": "", + "json_tag": "connection" + }, + "Description": { + "name": "Description", + "description": "Customer-provided service token description", + "json_tag": "description" + }, + "ExpirationDateTime": { + "name": "ExpirationDateTime", + "description": "Expiration date and time of the service token.", + "json_tag": "expirationDateTime" + }, + "Expiry": { + "name": "Expiry", + "description": "Deprecated", + "json_tag": "expiry" + }, + "Href": { + "name": "Href", + "description": "An absolute URL that is the subject of the link's context.", + "json_tag": "href" + }, + "IssuerSide": { + "name": "IssuerSide", + "description": "information about token side\nDeprecated", + "json_tag": "issuerSide" + }, + "Name": { + "name": "Name", + "description": "Customer-provided service token name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Service token related notifications", + "json_tag": "notifications" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned service token identifier", + "json_tag": "uuid" + } + } + }, + "ServiceTokenActionRequest": { + "type_name": "ServiceTokenActionRequest", + "description": "ServiceTokenActionRequest Service Token action request", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ServiceTokenChangeOperation": { + "type_name": "ServiceTokenChangeOperation", + "description": "ServiceTokenChangeOperation Service Token change operation data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Op": { + "name": "Op", + "description": "", + "json_tag": "op" + }, + "Path": { + "name": "Path", + "description": "path inside document leading to updated parameter", + "json_tag": "path" + }, + "Value": { + "name": "Value", + "description": "new value for updated parameter", + "json_tag": "value" + } + } + }, + "ServiceTokenConnection": { + "type_name": "ServiceTokenConnection", + "description": "ServiceTokenConnection Service Token Connection Type Information", + "fields": { + "ASide": { + "name": "ASide", + "description": "", + "json_tag": "aSide" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AllowCustomBandwidth": { + "name": "AllowCustomBandwidth", + "description": "Allow custom bandwidth value", + "json_tag": "allowCustomBandwidth" + }, + "AllowRemoteConnection": { + "name": "AllowRemoteConnection", + "description": "Authorization to connect remotely", + "json_tag": "allowRemoteConnection" + }, + "BandwidthLimit": { + "name": "BandwidthLimit", + "description": "Connection bandwidth limit in Mbps", + "json_tag": "bandwidthLimit" + }, + "Href": { + "name": "Href", + "description": "An absolute URL that is the subject of the link's context.", + "json_tag": "href" + }, + "SupportedBandwidths": { + "name": "SupportedBandwidths", + "description": "List of permitted bandwidths.", + "json_tag": "supportedBandwidths" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned connection identifier", + "json_tag": "uuid" + }, + "ZSide": { + "name": "ZSide", + "description": "", + "json_tag": "zSide" + } + } + }, + "ServiceTokenSearchExpression": { + "type_name": "ServiceTokenSearchExpression", + "description": "ServiceTokenSearchExpression struct for ServiceTokenSearchExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + }, + "Operator": { + "name": "Operator", + "description": "", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "ServiceTokenSearchRequest": { + "type_name": "ServiceTokenSearchRequest", + "description": "ServiceTokenSearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "ServiceTokenSide": { + "type_name": "ServiceTokenSide", + "description": "ServiceTokenSide Connection link protocol,virtual device or network configuration", + "fields": { + "AccessPointSelectors": { + "name": "AccessPointSelectors", + "description": "List of AccessPointSelectors", + "json_tag": "accessPointSelectors" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + } + } + }, + "ServiceTokens": { + "type_name": "ServiceTokens", + "description": "ServiceTokens Service tokens authorize a user to access protected resources and services available on the Equinix Fabric network. The owner of the resources can distribute service tokens to third-party users (trusted partners and vendors), allowing them to directly access and work with the resources on the network without involving the resource owners.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Data": { + "name": "Data", + "description": "List of Service Tokens", + "json_tag": "data" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + } + } + }, + "Services": { + "type_name": "Services", + "description": "Services Arrays of objects containing type of services supported in the specified metros", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Type": { + "name": "Type", + "description": "Type of Service", + "json_tag": "type" + } + } + }, + "SimplifiedAccount": { + "type_name": "SimplifiedAccount", + "description": "SimplifiedAccount struct for SimplifiedAccount", + "fields": { + "AccountName": { + "name": "AccountName", + "description": "Account name", + "json_tag": "accountName" + }, + "AccountNumber": { + "name": "AccountNumber", + "description": "Account number", + "json_tag": "accountNumber" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "GlobalCustId": { + "name": "GlobalCustId", + "description": "Account name", + "json_tag": "globalCustId" + }, + "GlobalOrgId": { + "name": "GlobalOrgId", + "description": "Global organization identifier", + "json_tag": "globalOrgId" + }, + "GlobalOrganizationName": { + "name": "GlobalOrganizationName", + "description": "Global organization name", + "json_tag": "globalOrganizationName" + }, + "OrgId": { + "name": "OrgId", + "description": "Customer organization identifier", + "json_tag": "orgId" + }, + "OrganizationName": { + "name": "OrganizationName", + "description": "Customer organization name", + "json_tag": "organizationName" + }, + "ResellerAccountName": { + "name": "ResellerAccountName", + "description": "Reseller account name", + "json_tag": "resellerAccountName" + }, + "ResellerAccountNumber": { + "name": "ResellerAccountNumber", + "description": "Reseller account number", + "json_tag": "resellerAccountNumber" + }, + "ResellerOrgId": { + "name": "ResellerOrgId", + "description": "Reseller customer organization identifier", + "json_tag": "resellerOrgId" + }, + "ResellerUcmId": { + "name": "ResellerUcmId", + "description": "Reseller account ucmId", + "json_tag": "resellerUcmId" + }, + "UcmId": { + "name": "UcmId", + "description": "Account ucmId", + "json_tag": "ucmId" + } + } + }, + "SimplifiedLinkProtocol": { + "type_name": "SimplifiedLinkProtocol", + "description": "SimplifiedLinkProtocol Connection link protocol Configuration", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "VlanCTag": { + "name": "VlanCTag", + "description": "vlanCTag value specified for QINQ connections", + "json_tag": "vlanCTag" + }, + "VlanSTag": { + "name": "VlanSTag", + "description": "vlanSTag value specified for QINQ connections", + "json_tag": "vlanSTag" + }, + "VlanTag": { + "name": "VlanTag", + "description": "vlanTag value specified for DOT1Q connections", + "json_tag": "vlanTag" + } + } + }, + "SimplifiedLocation": { + "type_name": "SimplifiedLocation", + "description": "SimplifiedLocation struct for SimplifiedLocation", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Ibx": { + "name": "Ibx", + "description": "Deprecated", + "json_tag": "ibx" + }, + "MetroCode": { + "name": "MetroCode", + "description": "", + "json_tag": "metroCode" + }, + "MetroHref": { + "name": "MetroHref", + "description": "", + "json_tag": "metroHref" + }, + "MetroName": { + "name": "MetroName", + "description": "", + "json_tag": "metroName" + }, + "Region": { + "name": "Region", + "description": "", + "json_tag": "region" + } + } + }, + "SimplifiedLocationWithoutIBX": { + "type_name": "SimplifiedLocationWithoutIBX", + "description": "SimplifiedLocationWithoutIBX struct for SimplifiedLocationWithoutIBX", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "MetroCode": { + "name": "MetroCode", + "description": "", + "json_tag": "metroCode" + }, + "MetroHref": { + "name": "MetroHref", + "description": "The Canonical URL at which the resource resides.", + "json_tag": "metroHref" + }, + "MetroName": { + "name": "MetroName", + "description": "", + "json_tag": "metroName" + }, + "Region": { + "name": "Region", + "description": "", + "json_tag": "region" + } + } + }, + "SimplifiedMetadataEntity": { + "type_name": "SimplifiedMetadataEntity", + "description": "SimplifiedMetadataEntity Configuration details for port used at the access point.", + "fields": { + "AccountName": { + "name": "AccountName", + "description": "Account Name", + "json_tag": "accountName" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Port Bandwidth", + "json_tag": "bandwidth" + }, + "CvpId": { + "name": "CvpId", + "description": "Customer virtual port Id", + "json_tag": "cvpId" + }, + "EncapsulationProtocolType": { + "name": "EncapsulationProtocolType", + "description": "Port Encapsulation", + "json_tag": "encapsulationProtocolType" + }, + "Href": { + "name": "Href", + "description": "url to entity", + "json_tag": "href" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "PortName": { + "name": "PortName", + "description": "Port Name", + "json_tag": "portName" + }, + "Priority": { + "name": "Priority", + "description": "Port Priority", + "json_tag": "priority" + }, + "Type": { + "name": "Type", + "description": "Type of Port", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix assigned Identifier", + "json_tag": "uuid" + } + } + }, + "SimplifiedNetwork": { + "type_name": "SimplifiedNetwork", + "description": "SimplifiedNetwork Network specification", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Change": { + "name": "Change", + "description": "", + "json_tag": "change" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Href": { + "name": "Href", + "description": "Network URI", + "json_tag": "href" + }, + "Links": { + "name": "Links", + "description": "Network sub-resources links", + "json_tag": "links" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Name": { + "name": "Name", + "description": "Customer-assigned network name", + "json_tag": "name" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "Scope": { + "name": "Scope", + "description": "", + "json_tag": "scope" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned network identifier", + "json_tag": "uuid" + } + } + }, + "SimplifiedNetworkChange": { + "type_name": "SimplifiedNetworkChange", + "description": "SimplifiedNetworkChange Current state of latest network change", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Network URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Uniquely identifies a change", + "json_tag": "uuid" + } + } + }, + "SimplifiedNotification": { + "type_name": "SimplifiedNotification", + "description": "SimplifiedNotification struct for SimplifiedNotification", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Emails": { + "name": "Emails", + "description": "Array of contact emails", + "json_tag": "emails" + }, + "RegisteredUsers": { + "name": "RegisteredUsers", + "description": "Array of registered users", + "json_tag": "registeredUsers" + }, + "SendInterval": { + "name": "SendInterval", + "description": "", + "json_tag": "sendInterval" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "SimplifiedPort": { + "type_name": "SimplifiedPort", + "description": "SimplifiedPort Port specification", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Port additional information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AvailableBandwidth": { + "name": "AvailableBandwidth", + "description": "Equinix assigned response attribute for Port available bandwidth in Mbps", + "json_tag": "availableBandwidth" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Equinix assigned response attribute for Port bandwidth in Mbps", + "json_tag": "bandwidth" + }, + "ConnectionsCount": { + "name": "ConnectionsCount", + "description": "Equinix assigned response attribute for Connection count", + "json_tag": "connectionsCount" + }, + "DemarcationPoint": { + "name": "DemarcationPoint", + "description": "", + "json_tag": "demarcationPoint" + }, + "Description": { + "name": "Description", + "description": "Equinix assigned response attribute for Port description", + "json_tag": "description" + }, + "Device": { + "name": "Device", + "description": "", + "json_tag": "device" + }, + "Encapsulation": { + "name": "Encapsulation", + "description": "", + "json_tag": "encapsulation" + }, + "Href": { + "name": "Href", + "description": "Equinix assigned response attribute for an absolute URL that is the subject of the link's context.", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "Equinix assigned response attribute for Port Id", + "json_tag": "id" + }, + "Interface": { + "name": "Interface", + "description": "", + "json_tag": "interface" + }, + "LagEnabled": { + "name": "LagEnabled", + "description": "If LAG enabled", + "json_tag": "lagEnabled" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Name": { + "name": "Name", + "description": "Equinix assigned response attribute for Port name", + "json_tag": "name" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "PhysicalPortQuantity": { + "name": "PhysicalPortQuantity", + "description": "Number of physical ports", + "json_tag": "physicalPortQuantity" + }, + "PhysicalPorts": { + "name": "PhysicalPorts", + "description": "Physical ports that implement this port", + "json_tag": "physicalPorts" + }, + "PhysicalPortsSpeed": { + "name": "PhysicalPortsSpeed", + "description": "Physical Ports Speed in Mbps", + "json_tag": "physicalPortsSpeed" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Redundancy": { + "name": "Redundancy", + "description": "", + "json_tag": "redundancy" + }, + "ServiceType": { + "name": "ServiceType", + "description": "Deprecated", + "json_tag": "serviceType" + }, + "Settings": { + "name": "Settings", + "description": "", + "json_tag": "settings" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Tether": { + "name": "Tether", + "description": "", + "json_tag": "tether" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UsedBandwidth": { + "name": "UsedBandwidth", + "description": "Equinix assigned response attribute for Port used bandwidth in Mbps", + "json_tag": "usedBandwidth" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix assigned response attribute for port identifier", + "json_tag": "uuid" + } + } + }, + "SimplifiedServiceProfile": { + "type_name": "SimplifiedServiceProfile", + "description": "SimplifiedServiceProfile Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.", + "fields": { + "AccessPointTypeConfigs": { + "name": "AccessPointTypeConfigs", + "description": "", + "json_tag": "accessPointTypeConfigs" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AllowedEmails": { + "name": "AllowedEmails", + "description": "", + "json_tag": "allowedEmails" + }, + "CustomFields": { + "name": "CustomFields", + "description": "", + "json_tag": "customFields" + }, + "Description": { + "name": "Description", + "description": "User-provided service description should be of maximum length 375", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Service Profile URI response attribute", + "json_tag": "href" + }, + "MarketingInfo": { + "name": "MarketingInfo", + "description": "", + "json_tag": "marketingInfo" + }, + "Metros": { + "name": "Metros", + "description": "Derived response attribute.", + "json_tag": "metros" + }, + "Name": { + "name": "Name", + "description": "Customer-assigned service profile name", + "json_tag": "name" + }, + "Notifications": { + "name": "Notifications", + "description": "Recipients of notifications on service profile change", + "json_tag": "notifications" + }, + "Ports": { + "name": "Ports", + "description": "", + "json_tag": "ports" + }, + "ProjectId": { + "name": "ProjectId", + "description": "", + "json_tag": "projectId" + }, + "SelfProfile": { + "name": "SelfProfile", + "description": "response attribute indicates whether the profile belongs to the same organization as the api-invoker.", + "json_tag": "selfProfile" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned service profile identifier", + "json_tag": "uuid" + }, + "VirtualDevices": { + "name": "VirtualDevices", + "description": "", + "json_tag": "virtualDevices" + }, + "Visibility": { + "name": "Visibility", + "description": "", + "json_tag": "visibility" + } + } + }, + "SimplifiedTokenNetwork": { + "type_name": "SimplifiedTokenNetwork", + "description": "SimplifiedTokenNetwork struct for SimplifiedTokenNetwork", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "url to entity", + "json_tag": "href" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Name": { + "name": "Name", + "description": "Network Name", + "json_tag": "name" + }, + "Scope": { + "name": "Scope", + "description": "", + "json_tag": "scope" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Network Identifier", + "json_tag": "uuid" + } + } + }, + "SimplifiedVirtualDevice": { + "type_name": "SimplifiedVirtualDevice", + "description": "SimplifiedVirtualDevice struct for SimplifiedVirtualDevice", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cluster": { + "name": "Cluster", + "description": "Virtual Device Cluster Information", + "json_tag": "cluster" + }, + "Href": { + "name": "Href", + "description": "url to entity", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "Customer-assigned Virtual Device name", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Network Edge assigned Virtual Device Identifier", + "json_tag": "uuid" + } + } + }, + "SortCriteria": { + "type_name": "SortCriteria", + "description": "SortCriteria struct for SortCriteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "SortCriteriaResponse": { + "type_name": "SortCriteriaResponse", + "description": "SortCriteriaResponse struct for SortCriteriaResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "SortItem": { + "type_name": "SortItem", + "description": "SortItem struct for SortItem", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "Statistics": { + "type_name": "Statistics", + "description": "Statistics This API provides service-level traffic metrics so that you can view access and gather key information required to manage service subscription sizing and capacity.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BandwidthUtilization": { + "name": "BandwidthUtilization", + "description": "", + "json_tag": "bandwidthUtilization" + }, + "EndDateTime": { + "name": "EndDateTime", + "description": "End and duration of the statistical analysis interval.", + "json_tag": "endDateTime" + }, + "StartDateTime": { + "name": "StartDateTime", + "description": "Start and duration of the statistical analysis interval.", + "json_tag": "startDateTime" + }, + "ViewPoint": { + "name": "ViewPoint", + "description": "", + "json_tag": "viewPoint" + } + } + }, + "Stream": { + "type_name": "Stream", + "description": "Stream Stream object", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AlertRulesCount": { + "name": "AlertRulesCount", + "description": "Stream alert rules count", + "json_tag": "alertRulesCount" + }, + "AssetsCount": { + "name": "AssetsCount", + "description": "Stream assets count", + "json_tag": "assetsCount" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Description": { + "name": "Description", + "description": "Customer-provided stream description", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "Stream URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "Customer-provided stream name", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "StreamSubscriptionsCount": { + "name": "StreamSubscriptionsCount", + "description": "Stream subscriptions count", + "json_tag": "streamSubscriptionsCount" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned access point identifier", + "json_tag": "uuid" + } + } + }, + "StreamAlertRule": { + "type_name": "StreamAlertRule", + "description": "StreamAlertRule Stream object", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Description": { + "name": "Description", + "description": "Customer-provided stream alert rule description", + "json_tag": "description" + }, + "DetectionMethod": { + "name": "DetectionMethod", + "description": "", + "json_tag": "detectionMethod" + }, + "Enabled": { + "name": "Enabled", + "description": "Stream alert rule enabled status", + "json_tag": "enabled" + }, + "Href": { + "name": "Href", + "description": "Stream Alert Rule URI", + "json_tag": "href" + }, + "MetricSelector": { + "name": "MetricSelector", + "description": "", + "json_tag": "metricSelector" + }, + "Name": { + "name": "Name", + "description": "Customer-provided stream alert rule name", + "json_tag": "name" + }, + "ResourceSelector": { + "name": "ResourceSelector", + "description": "", + "json_tag": "resourceSelector" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned access point identifier", + "json_tag": "uuid" + } + } + }, + "StreamAsset": { + "type_name": "StreamAsset", + "description": "StreamAsset Stream object", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AttachmentStatus": { + "name": "AttachmentStatus", + "description": "", + "json_tag": "attachmentStatus" + }, + "Href": { + "name": "Href", + "description": "Stream Asset URI", + "json_tag": "href" + }, + "MetricsEnabled": { + "name": "MetricsEnabled", + "description": "enable metric", + "json_tag": "metricsEnabled" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned access point identifier", + "json_tag": "uuid" + } + } + }, + "StreamAssetFilter": { + "type_name": "StreamAssetFilter", + "description": "StreamAssetFilter struct for StreamAssetFilter", + "fields": { + "StreamAssetOrFilter": { + "name": "StreamAssetOrFilter", + "description": "" + }, + "StreamAssetSimpleExpression": { + "name": "StreamAssetSimpleExpression", + "description": "" + } + } + }, + "StreamAssetFilters": { + "type_name": "StreamAssetFilters", + "description": "StreamAssetFilters struct for StreamAssetFilters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "StreamAssetOrFilter": { + "type_name": "StreamAssetOrFilter", + "description": "StreamAssetOrFilter struct for StreamAssetOrFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + } + } + }, + "StreamAssetPutRequest": { + "type_name": "StreamAssetPutRequest", + "description": "StreamAssetPutRequest Update Stream Asset", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "MetricsEnabled": { + "name": "MetricsEnabled", + "description": "enable metric", + "json_tag": "metricsEnabled" + } + } + }, + "StreamAssetSearchRequest": { + "type_name": "StreamAssetSearchRequest", + "description": "StreamAssetSearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "StreamAssetSimpleExpression": { + "type_name": "StreamAssetSimpleExpression", + "description": "StreamAssetSimpleExpression struct for StreamAssetSimpleExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Possible operators to use on filters: * `=` - equal * `!=` - not equal * `\u003e` - greater than * `\u003e=` - greater than or equal to * `\u003c` - less than * `\u003c=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `ILIKE` - case-insensitive like", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Possible field names to use on filters: * `/uuid` - Asset uuid * `/streamUuid` - Stream uuid * `/projectId` - Asset projectId * `/_*` - all-category search", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "StreamAssetSortCriteria": { + "type_name": "StreamAssetSortCriteria", + "description": "StreamAssetSortCriteria struct for StreamAssetSortCriteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "StreamFilter": { + "type_name": "StreamFilter", + "description": "StreamFilter struct for StreamFilter", + "fields": { + "StreamFilterOrFilter": { + "name": "StreamFilterOrFilter", + "description": "" + }, + "StreamFilterSimpleExpression": { + "name": "StreamFilterSimpleExpression", + "description": "" + } + } + }, + "StreamFilterOrFilter": { + "type_name": "StreamFilterOrFilter", + "description": "StreamFilterOrFilter struct for StreamFilterOrFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + } + } + }, + "StreamFilterSimpleExpression": { + "type_name": "StreamFilterSimpleExpression", + "description": "StreamFilterSimpleExpression struct for StreamFilterSimpleExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Possible operators to use on filters: * `=` - equal * `in` - in * `LIKE` - case-sensitive like * `ILIKE` - case-insensitive like", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Possible field names to use on filters: * `/subject` - subject * `/type` - type", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "### Supported event or metric names to use on filters with property /type: * `*` - all events or metrics * `equinix.fabric.port.*` - port events or metrics * `equinix.fabric.connection.*` - connection events or metrics * `equinix.fabric.router.*` - cloud router events * `equinix.fabric.metro.*` - metro metrics * `equinix.fabric.network.*` - network events * `equinix.fabric.service_token.*` - service token events * `equinix.network_edge.*` - network edge events * `equinix.network_edge.acl.*` - network edge acl events * `equinix.network_edge.device.*` - network edge device events * `equinix.access_manager.*` - identity access manager events * `equinix.access_manager.user.role.*` - identity access manager user role events ### Supported event or metric names to use on filters with property /subject: * `*` - all events or metrics * `/fabric/v4/ports/\u003cuuid\u003e` - port events or metrics * `/fabric/v4/connections/\u003cuuid\u003e` - connection events or metrics * `/fabric/v4/routers/\u003cuuid\u003e` - cloud router events * `/fabric/v4/metros/\u003cmetroCode\u003e` - metro metrics * `/fabric/v4/networks/\u003cuuid\u003e` - network events * `/fabric/v4/tokens/\u003cuuid\u003e` - service token events * `/ne/v1/acl/\u003cuuid\u003e` - network edge acl events * `/ne/v1/devices/\u003cuuid\u003e` - network edge device events * `/am/v2/users/\u003cuuid\u003e/roleAssignments/\u003cuuid\u003e` - identity access manager events", + "json_tag": "values" + } + } + }, + "StreamPostRequest": { + "type_name": "StreamPostRequest", + "description": "StreamPostRequest Create Stream", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Customer-provided stream description", + "json_tag": "description" + }, + "Name": { + "name": "Name", + "description": "Customer-provided stream name", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "StreamPutRequest": { + "type_name": "StreamPutRequest", + "description": "StreamPutRequest Update Stream", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Customer-provided stream description", + "json_tag": "description" + }, + "Name": { + "name": "Name", + "description": "Customer-provided stream name", + "json_tag": "name" + } + } + }, + "StreamSubscription": { + "type_name": "StreamSubscription", + "description": "StreamSubscription Stream Subscription object", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ChangeLog": { + "name": "ChangeLog", + "description": "", + "json_tag": "changeLog" + }, + "Description": { + "name": "Description", + "description": "Customer-provided subscription description", + "json_tag": "description" + }, + "Enabled": { + "name": "Enabled", + "description": "Stream subscription enabled status", + "json_tag": "enabled" + }, + "EventSelector": { + "name": "EventSelector", + "description": "", + "json_tag": "eventSelector" + }, + "Href": { + "name": "Href", + "description": "Stream Subscription URI", + "json_tag": "href" + }, + "MetricSelector": { + "name": "MetricSelector", + "description": "", + "json_tag": "metricSelector" + }, + "Name": { + "name": "Name", + "description": "Customer-provided subscription name", + "json_tag": "name" + }, + "Operation": { + "name": "Operation", + "description": "", + "json_tag": "operation" + }, + "Sink": { + "name": "Sink", + "description": "", + "json_tag": "sink" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned access point identifier", + "json_tag": "uuid" + } + } + }, + "StreamSubscriptionFilter": { + "type_name": "StreamSubscriptionFilter", + "description": "StreamSubscriptionFilter struct for StreamSubscriptionFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "StreamSubscriptionOperation": { + "type_name": "StreamSubscriptionOperation", + "description": "StreamSubscriptionOperation Stream subscription operational information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AlertsDeliveredCount": { + "name": "AlertsDeliveredCount", + "description": "count of delivered alerts", + "json_tag": "alertsDeliveredCount" + }, + "Errors": { + "name": "Errors", + "description": "List of error information for stream subscription delivery", + "json_tag": "errors" + }, + "EventsDeliveredCount": { + "name": "EventsDeliveredCount", + "description": "count of delivered events", + "json_tag": "eventsDeliveredCount" + }, + "LastSuccessfulDeliveryDateTime": { + "name": "LastSuccessfulDeliveryDateTime", + "description": "last successful date time of delivered event, metric, or alert", + "json_tag": "lastSuccessfulDeliveryDateTime" + }, + "MetricsDeliveredCount": { + "name": "MetricsDeliveredCount", + "description": "count of delivered metrics", + "json_tag": "metricsDeliveredCount" + }, + "SuspendedDateTime": { + "name": "SuspendedDateTime", + "description": "suspended date time of stream subscription delivery for event, metric, or alert", + "json_tag": "suspendedDateTime" + } + } + }, + "StreamSubscriptionOperationAdditionalInfo": { + "type_name": "StreamSubscriptionOperationAdditionalInfo", + "description": "StreamSubscriptionOperationAdditionalInfo External error information from subscription sink", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Property": { + "name": "Property", + "description": "Additional attribute for error information", + "json_tag": "property" + }, + "Reason": { + "name": "Reason", + "description": "HTTP error message response from sink type if error occurred", + "json_tag": "reason" + }, + "StatusCode": { + "name": "StatusCode", + "description": "HTTP error status code response from sink type if error occurred", + "json_tag": "statusCode" + } + } + }, + "StreamSubscriptionOperationErrors": { + "type_name": "StreamSubscriptionOperationErrors", + "description": "StreamSubscriptionOperationErrors Error information for stream subscription delivery", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DateTime": { + "name": "DateTime", + "description": "Equinix Observability error date time", + "json_tag": "dateTime" + }, + "ErrorCode": { + "name": "ErrorCode", + "description": "Equinix Observability error code", + "json_tag": "errorCode" + }, + "ErrorMessage": { + "name": "ErrorMessage", + "description": "Equinix Observability error message", + "json_tag": "errorMessage" + } + } + }, + "StreamSubscriptionPostRequest": { + "type_name": "StreamSubscriptionPostRequest", + "description": "StreamSubscriptionPostRequest Create Stream Subscription", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Customer-provided stream subscription description", + "json_tag": "description" + }, + "Enabled": { + "name": "Enabled", + "description": "Stream subscription enabled status", + "json_tag": "enabled" + }, + "EventSelector": { + "name": "EventSelector", + "description": "", + "json_tag": "eventSelector" + }, + "MetricSelector": { + "name": "MetricSelector", + "description": "", + "json_tag": "metricSelector" + }, + "Name": { + "name": "Name", + "description": "Customer-provided stream subscription name", + "json_tag": "name" + }, + "Sink": { + "name": "Sink", + "description": "", + "json_tag": "sink" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "StreamSubscriptionPutRequest": { + "type_name": "StreamSubscriptionPutRequest", + "description": "StreamSubscriptionPutRequest Update Stream Subscription", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "Customer-provided stream subscription description", + "json_tag": "description" + }, + "Enabled": { + "name": "Enabled", + "description": "Stream subscription enabled status", + "json_tag": "enabled" + }, + "EventSelector": { + "name": "EventSelector", + "description": "", + "json_tag": "eventSelector" + }, + "Filters": { + "name": "Filters", + "description": "", + "json_tag": "filters" + }, + "MetricSelector": { + "name": "MetricSelector", + "description": "", + "json_tag": "metricSelector" + }, + "Name": { + "name": "Name", + "description": "Customer-provided stream subscription name", + "json_tag": "name" + }, + "Sink": { + "name": "Sink", + "description": "", + "json_tag": "sink" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "StreamSubscriptionSelector": { + "type_name": "StreamSubscriptionSelector", + "description": "StreamSubscriptionSelector struct for StreamSubscriptionSelector", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Except": { + "name": "Except", + "description": "", + "json_tag": "except" + }, + "Include": { + "name": "Include", + "description": "", + "json_tag": "include" + } + } + }, + "StreamSubscriptionSink": { + "type_name": "StreamSubscriptionSink", + "description": "StreamSubscriptionSink Create Stream destination", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BatchEnabled": { + "name": "BatchEnabled", + "description": "batch mode on/off", + "json_tag": "batchEnabled" + }, + "BatchSizeMax": { + "name": "BatchSizeMax", + "description": "maximum batch size", + "json_tag": "batchSizeMax" + }, + "BatchWaitTimeMax": { + "name": "BatchWaitTimeMax", + "description": "maximum batch waiting time", + "json_tag": "batchWaitTimeMax" + }, + "Credential": { + "name": "Credential", + "description": "", + "json_tag": "credential" + }, + "Host": { + "name": "Host", + "description": "sink host", + "json_tag": "host" + }, + "Settings": { + "name": "Settings", + "description": "", + "json_tag": "settings" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uri": { + "name": "Uri", + "description": "any publicly reachable http endpoint", + "json_tag": "uri" + } + } + }, + "StreamSubscriptionSinkCredential": { + "type_name": "StreamSubscriptionSinkCredential", + "description": "StreamSubscriptionSinkCredential Stream subscription sink credentials", + "fields": { + "AccessToken": { + "name": "AccessToken", + "description": "passed as Authorization header value", + "json_tag": "accessToken" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ApiKey": { + "name": "ApiKey", + "description": "passed as Authorization header value", + "json_tag": "apiKey" + }, + "IntegrationKey": { + "name": "IntegrationKey", + "description": "passed as Authorization header value", + "json_tag": "integrationKey" + }, + "Password": { + "name": "Password", + "description": "passed as Authorization header value", + "json_tag": "password" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Username": { + "name": "Username", + "description": "passed as Authorization header value", + "json_tag": "username" + } + } + }, + "StreamSubscriptionSinkResponse": { + "type_name": "StreamSubscriptionSinkResponse", + "description": "StreamSubscriptionSinkResponse Create Stream destination", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BatchEnabled": { + "name": "BatchEnabled", + "description": "batch mode on/off", + "json_tag": "batchEnabled" + }, + "BatchSizeMax": { + "name": "BatchSizeMax", + "description": "maximum batch size", + "json_tag": "batchSizeMax" + }, + "BatchWaitTimeMax": { + "name": "BatchWaitTimeMax", + "description": "maximum batch waiting time", + "json_tag": "batchWaitTimeMax" + }, + "Credential": { + "name": "Credential", + "description": "", + "json_tag": "credential" + }, + "Host": { + "name": "Host", + "description": "sink host", + "json_tag": "host" + }, + "Settings": { + "name": "Settings", + "description": "", + "json_tag": "settings" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uri": { + "name": "Uri", + "description": "any publicly reachable http endpoint", + "json_tag": "uri" + } + } + }, + "StreamSubscriptionSinkSetting": { + "type_name": "StreamSubscriptionSinkSetting", + "description": "StreamSubscriptionSinkSetting Stream subscription sink settings", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ApplicationKey": { + "name": "ApplicationKey", + "description": "Application key", + "json_tag": "applicationKey" + }, + "EventIndex": { + "name": "EventIndex", + "description": "event index", + "json_tag": "eventIndex" + }, + "EventUri": { + "name": "EventUri", + "description": "event uri", + "json_tag": "eventUri" + }, + "Format": { + "name": "Format", + "description": "", + "json_tag": "format" + }, + "MetricIndex": { + "name": "MetricIndex", + "description": "metric index", + "json_tag": "metricIndex" + }, + "MetricUri": { + "name": "MetricUri", + "description": "metric uri", + "json_tag": "metricUri" + }, + "Source": { + "name": "Source", + "description": "source", + "json_tag": "source" + } + } + }, + "SubInterface": { + "type_name": "SubInterface", + "description": "SubInterface Sub Interface information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Name": { + "name": "Name", + "description": "name of subinterafce of a port", + "json_tag": "name" + }, + "Unit": { + "name": "Unit", + "description": "", + "json_tag": "unit" + } + } + }, + "Subnet": { + "type_name": "Subnet", + "description": "Subnet struct for Subnet", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Ipv4": { + "name": "Ipv4", + "description": "", + "json_tag": "ipv4" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "VpcId": { + "name": "VpcId", + "description": "", + "json_tag": "vpcId" + } + } + }, + "SubscriptionAsset": { + "type_name": "SubscriptionAsset", + "description": "SubscriptionAsset Asset information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Bandwidth of the asset in Mbps", + "json_tag": "bandwidth" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "Type": { + "name": "Type", + "description": "Type of the subscription asset ( XF_ROUTER ,IP_VC, IPWAN_VC )", + "json_tag": "type" + } + } + }, + "SubscriptionEntitlementResponse": { + "type_name": "SubscriptionEntitlementResponse", + "description": "SubscriptionEntitlementResponse Subscription entitlement", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Asset": { + "name": "Asset", + "description": "", + "json_tag": "asset" + }, + "QuantityAvailable": { + "name": "QuantityAvailable", + "description": "Quantity available from the entitlement", + "json_tag": "quantityAvailable" + }, + "QuantityConsumed": { + "name": "QuantityConsumed", + "description": "Quantity consumed from the entitlement", + "json_tag": "quantityConsumed" + }, + "QuantityEntitled": { + "name": "QuantityEntitled", + "description": "Quantity entitled for the subscription", + "json_tag": "quantityEntitled" + }, + "Uuid": { + "name": "Uuid", + "description": "Subscription Entitlement Id", + "json_tag": "uuid" + } + } + }, + "SubscriptionResponse": { + "type_name": "SubscriptionResponse", + "description": "SubscriptionResponse Subscription Response", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Changelog": { + "name": "Changelog", + "description": "", + "json_tag": "changelog" + }, + "Entitlements": { + "name": "Entitlements", + "description": "List of entitlements associated with the subscription", + "json_tag": "entitlements" + }, + "Href": { + "name": "Href", + "description": "Subscription URL", + "json_tag": "href" + }, + "IsAutoRenew": { + "name": "IsAutoRenew", + "description": "Is Auto Renewal Enabled", + "json_tag": "isAutoRenew" + }, + "Marketplace": { + "name": "Marketplace", + "description": "", + "json_tag": "marketplace" + }, + "MetroCodes": { + "name": "MetroCodes", + "description": "List of available metro", + "json_tag": "metroCodes" + }, + "OfferId": { + "name": "OfferId", + "description": "Marketplace Offer Id", + "json_tag": "offerId" + }, + "OfferType": { + "name": "OfferType", + "description": "", + "json_tag": "offerType" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Trial": { + "name": "Trial", + "description": "", + "json_tag": "trial" + }, + "Uuid": { + "name": "Uuid", + "description": "Unique identifier of the Subscription", + "json_tag": "uuid" + } + } + }, + "SubscriptionRouterPackageType": { + "type_name": "SubscriptionRouterPackageType", + "description": "SubscriptionRouterPackageType Cloud Router Package Type", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + } + } + }, + "SubscriptionTrial": { + "type_name": "SubscriptionTrial", + "description": "SubscriptionTrial Free Trial Subscription", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Enabled": { + "name": "Enabled", + "description": "Free Trial Enabled", + "json_tag": "enabled" + }, + "ExpiryDateTime": { + "name": "ExpiryDateTime", + "description": "Free Trial Expiry Date", + "json_tag": "expiryDateTime" + } + } + }, + "TimeServiceFilter": { + "type_name": "TimeServiceFilter", + "description": "TimeServiceFilter struct for TimeServiceFilter", + "fields": { + "TimeServiceOrFilter": { + "name": "TimeServiceOrFilter", + "description": "" + }, + "TimeServiceSimpleExpression": { + "name": "TimeServiceSimpleExpression", + "description": "" + } + } + }, + "TimeServiceFilters": { + "type_name": "TimeServiceFilters", + "description": "TimeServiceFilters struct for TimeServiceFilters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "TimeServiceOperation": { + "type_name": "TimeServiceOperation", + "description": "TimeServiceOperation time service operational data", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "OperationalStatus": { + "name": "OperationalStatus", + "description": "", + "json_tag": "operationalStatus" + } + } + }, + "TimeServiceOrFilter": { + "type_name": "TimeServiceOrFilter", + "description": "TimeServiceOrFilter struct for TimeServiceOrFilter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Or": { + "name": "Or", + "description": "", + "json_tag": "or" + } + } + }, + "TimeServicePrice": { + "type_name": "TimeServicePrice", + "description": "TimeServicePrice Time Service Product configuration", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Connection": { + "name": "Connection", + "description": "", + "json_tag": "connection" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "TimeServicePriceConnection": { + "type_name": "TimeServicePriceConnection", + "description": "TimeServicePriceConnection Time Service Price Connection configuration", + "fields": { + "ASide": { + "name": "ASide", + "description": "", + "json_tag": "aSide" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + } + } + }, + "TimeServicePriceConnectionASide": { + "type_name": "TimeServicePriceConnectionASide", + "description": "TimeServicePriceConnectionASide Time Service Price Connection ASide configuration", + "fields": { + "AccessPoint": { + "name": "AccessPoint", + "description": "", + "json_tag": "accessPoint" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + } + } + }, + "TimeServicePriceConnectionAccessPoint": { + "type_name": "TimeServicePriceConnectionAccessPoint", + "description": "TimeServicePriceConnectionAccessPoint Time Service Price Connection Access Point configuration", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + } + } + }, + "TimeServiceSimpleExpression": { + "type_name": "TimeServiceSimpleExpression", + "description": "TimeServiceSimpleExpression struct for TimeServiceSimpleExpression", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Possible operators to use on filters: * `=` - equal * `!=` - not equal * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `ILIKE` - case-insensitive like", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Possible field names to use on filters: * `/project/projectId` - project id (mandatory) * `/name` - Precision Time Service name * `/uuid` - Precision Time Service uuid * `/type` - Precision Time Service protocol * `/state` - Precision Time Service status * `/account/accountNumber` - Precision Time Service account number * `/package/code` - Precision Time Service package * `/_*` - all-category search", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "", + "json_tag": "values" + } + } + }, + "TimeServiceSortCriteria": { + "type_name": "TimeServiceSortCriteria", + "description": "TimeServiceSortCriteria struct for TimeServiceSortCriteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Property": { + "name": "Property", + "description": "", + "json_tag": "property" + } + } + }, + "TimeServicesSearchRequest": { + "type_name": "TimeServicesSearchRequest", + "description": "TimeServicesSearchRequest Search requests containing criteria", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + }, + "Pagination": { + "name": "Pagination", + "description": "", + "json_tag": "pagination" + }, + "Sort": { + "name": "Sort", + "description": "", + "json_tag": "sort" + } + } + }, + "TopologyProperties": { + "type_name": "TopologyProperties", + "description": "TopologyProperties TopologyProperties is a schema that defines the properties of a topology in the orchestrator. It includes the element ID and any dependencies that the topology may have.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DependsOn": { + "name": "DependsOn", + "description": "", + "json_tag": "dependsOn" + }, + "ElementId": { + "name": "ElementId", + "description": "", + "json_tag": "elementId" + } + } + }, + "VPC": { + "type_name": "VPC", + "description": "VPC struct for VPC", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ValidateConnectionResponse": { + "type_name": "ValidateConnectionResponse", + "description": "ValidateConnectionResponse Validate Connection specification", + "fields": { + "ASide": { + "name": "ASide", + "description": "", + "json_tag": "aSide" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Connection bandwidth in Mbps", + "json_tag": "bandwidth" + }, + "Redundancy": { + "name": "Redundancy", + "description": "", + "json_tag": "redundancy" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned connection identifier", + "json_tag": "uuid" + }, + "ZSide": { + "name": "ZSide", + "description": "", + "json_tag": "zSide" + } + } + }, + "ValidateRequest": { + "type_name": "ValidateRequest", + "description": "ValidateRequest Validate connection auth api key or vlan", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filter": { + "name": "Filter", + "description": "", + "json_tag": "filter" + } + } + }, + "ValidateRequestFilter": { + "type_name": "ValidateRequestFilter", + "description": "ValidateRequestFilter Filters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "And": { + "name": "And", + "description": "", + "json_tag": "and" + } + } + }, + "ValidateRequestFilterAnd": { + "type_name": "ValidateRequestFilterAnd", + "description": "ValidateRequestFilterAnd struct for ValidateRequestFilterAnd", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Operator": { + "name": "Operator", + "description": "Type of operation", + "json_tag": "operator" + }, + "Property": { + "name": "Property", + "description": "Path to property", + "json_tag": "property" + }, + "Values": { + "name": "Values", + "description": "Values for the given property", + "json_tag": "values" + } + } + }, + "ValidateSubnetResponse": { + "type_name": "ValidateSubnetResponse", + "description": "ValidateSubnetResponse ValidateResponse", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Additional information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + } + } + }, + "VirtualConnectionPrice": { + "type_name": "VirtualConnectionPrice", + "description": "VirtualConnectionPrice Virtual Connection Product configuration", + "fields": { + "ASide": { + "name": "ASide", + "description": "", + "json_tag": "aSide" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "", + "json_tag": "bandwidth" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Either uuid or rest of attributes are required", + "json_tag": "uuid" + }, + "ZSide": { + "name": "ZSide", + "description": "", + "json_tag": "zSide" + } + } + }, + "VirtualConnectionPriceASide": { + "type_name": "VirtualConnectionPriceASide", + "description": "VirtualConnectionPriceASide struct for VirtualConnectionPriceASide", + "fields": { + "AccessPoint": { + "name": "AccessPoint", + "description": "", + "json_tag": "accessPoint" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + } + } + }, + "VirtualConnectionPriceASideAccessPoint": { + "type_name": "VirtualConnectionPriceASideAccessPoint", + "description": "VirtualConnectionPriceASideAccessPoint struct for VirtualConnectionPriceASideAccessPoint", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Port": { + "name": "Port", + "description": "", + "json_tag": "port" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "VirtualConnectionPriceASideAccessPointPort": { + "type_name": "VirtualConnectionPriceASideAccessPointPort", + "description": "VirtualConnectionPriceASideAccessPointPort struct for VirtualConnectionPriceASideAccessPointPort", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Settings": { + "name": "Settings", + "description": "", + "json_tag": "settings" + } + } + }, + "VirtualConnectionPriceASideAccessPointPortSettings": { + "type_name": "VirtualConnectionPriceASideAccessPointPortSettings", + "description": "VirtualConnectionPriceASideAccessPointPortSettings struct for VirtualConnectionPriceASideAccessPointPortSettings", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Buyout": { + "name": "Buyout", + "description": "", + "json_tag": "buyout" + } + } + }, + "VirtualConnectionPriceZSide": { + "type_name": "VirtualConnectionPriceZSide", + "description": "VirtualConnectionPriceZSide struct for VirtualConnectionPriceZSide", + "fields": { + "AccessPoint": { + "name": "AccessPoint", + "description": "", + "json_tag": "accessPoint" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + } + } + }, + "VirtualConnectionPriceZSideAccessPoint": { + "type_name": "VirtualConnectionPriceZSideAccessPoint", + "description": "VirtualConnectionPriceZSideAccessPoint struct for VirtualConnectionPriceZSideAccessPoint", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bridge": { + "name": "Bridge", + "description": "", + "json_tag": "bridge" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Port": { + "name": "Port", + "description": "", + "json_tag": "port" + }, + "Profile": { + "name": "Profile", + "description": "", + "json_tag": "profile" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "VirtualConnectionPriceZSideAccessPointBridge": { + "type_name": "VirtualConnectionPriceZSideAccessPointBridge", + "description": "VirtualConnectionPriceZSideAccessPointBridge struct for VirtualConnectionPriceZSideAccessPointBridge", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + } + } + }, + "VirtualConnectionPriceZSideAccessPointBridgePackage": { + "type_name": "VirtualConnectionPriceZSideAccessPointBridgePackage", + "description": "VirtualConnectionPriceZSideAccessPointBridgePackage struct for VirtualConnectionPriceZSideAccessPointBridgePackage", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + } + } + }, + "VirtualConnectionPriceZSideAccessPointProfile": { + "type_name": "VirtualConnectionPriceZSideAccessPointProfile", + "description": "VirtualConnectionPriceZSideAccessPointProfile struct for VirtualConnectionPriceZSideAccessPointProfile", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Uuid": { + "name": "Uuid", + "description": "", + "json_tag": "uuid" + } + } + }, + "VirtualConnectionSide": { + "type_name": "VirtualConnectionSide", + "description": "VirtualConnectionSide Fabric Connection access point object.", + "fields": { + "AccessPoint": { + "name": "AccessPoint", + "description": "", + "json_tag": "accessPoint" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + } + } + }, + "VirtualConnectionTimeServiceResponse": { + "type_name": "VirtualConnectionTimeServiceResponse", + "description": "VirtualConnectionTimeServiceResponse Fabric Connection Precision Time Service Response Object", + "fields": { + "ASide": { + "name": "ASide", + "description": "", + "json_tag": "aSide" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Connection URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "Connection Type.", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Connection UUID.", + "json_tag": "uuid" + }, + "ZSide": { + "name": "ZSide", + "description": "", + "json_tag": "zSide" + } + } + }, + "VirtualConnectionUuid": { + "type_name": "VirtualConnectionUuid", + "description": "VirtualConnectionUuid UUID of the Fabric Connection Instance", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "Connection URI", + "json_tag": "href" + }, + "Type": { + "name": "Type", + "description": "Connection Type", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Connection UUID.", + "json_tag": "uuid" + } + } + }, + "VirtualDevice": { + "type_name": "VirtualDevice", + "description": "VirtualDevice Virtual Device AccessPoint Information", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cluster": { + "name": "Cluster", + "description": "Virtual Device Cluster Information", + "json_tag": "cluster" + }, + "Href": { + "name": "Href", + "description": "Virtual Device URI", + "json_tag": "href" + }, + "Name": { + "name": "Name", + "description": "Customer-assigned Virtual Device name", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned Virtual Device identifier", + "json_tag": "uuid" + } + } + }, + "VirtualDeviceInterface": { + "type_name": "VirtualDeviceInterface", + "description": "VirtualDeviceInterface Virtual Device Interface Information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Id": { + "name": "Id", + "description": "Network Edge assigned identifier", + "json_tag": "id" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Interface identifier", + "json_tag": "uuid" + } + } + }, + "VirtualNetwork": { + "type_name": "VirtualNetwork", + "description": "VirtualNetwork Virtual Network Information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "The Canonical URL at which the resource resides.", + "json_tag": "href" + }, + "Uuid": { + "name": "Uuid", + "description": "Equinix-assigned Virtual Network identifier", + "json_tag": "uuid" + } + } + }, + "VirtualPortConfiguration": { + "type_name": "VirtualPortConfiguration", + "description": "VirtualPortConfiguration Port configuration.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Buyout": { + "name": "Buyout", + "description": "Buyout (true) or standard (false) configuration of the port at this access point. \u003cbr\u003e Buyout ports offer free, unlimited connections. Standard ports do not. The default is false.", + "json_tag": "buyout" + } + } + }, + "VirtualPortLocation": { + "type_name": "VirtualPortLocation", + "description": "VirtualPortLocation Geographic data for the port.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Ibx": { + "name": "Ibx", + "description": "Code assigned to the Equinix International Business Exchange (IBX) data center from which the port is ordered. \u003cbr\u003e The port might be in a different location.", + "json_tag": "ibx" + } + } + }, + "VirtualPortPackage": { + "type_name": "VirtualPortPackage", + "description": "VirtualPortPackage Virtual Port Package", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "Virtual port package code", + "json_tag": "code" + } + } + }, + "VirtualPortPrice": { + "type_name": "VirtualPortPrice", + "description": "VirtualPortPrice Preferences and settings for a virtual port connected to an internet service provider (ISP) or other Equinix platform entity.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Aggregated data transfer capacity, expressed as follows \u003cbr\u003e -\u003e Mbps, megabits (1 million bits) per second \u003cbr\u003e -\u003e Gbps, gigabits (1 billion bits) per second \u003cbr\u003e Bandwidth must be divisible by physicalPortsQuantity.", + "json_tag": "bandwidth" + }, + "ConnectivitySource": { + "name": "ConnectivitySource", + "description": "", + "json_tag": "connectivitySource" + }, + "Lag": { + "name": "Lag", + "description": "", + "json_tag": "lag" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Package": { + "name": "Package", + "description": "", + "json_tag": "package" + }, + "PhysicalPortsQuantity": { + "name": "PhysicalPortsQuantity", + "description": "Number of physical ports requested. The defaults is 1.", + "json_tag": "physicalPortsQuantity" + }, + "Redundancy": { + "name": "Redundancy", + "description": "", + "json_tag": "redundancy" + }, + "ServiceType": { + "name": "ServiceType", + "description": "", + "json_tag": "serviceType" + }, + "Settings": { + "name": "Settings", + "description": "", + "json_tag": "settings" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Uuid": { + "name": "Uuid", + "description": "Unique identifier assigned to the virtual port. Either the uuid or the remaining attributes must be supplied.", + "json_tag": "uuid" + } + } + }, + "VirtualPortRedundancy": { + "type_name": "VirtualPortRedundancy", + "description": "VirtualPortRedundancy Specifications for redundant connections, which improve service continuity by routing traffic to secondary ports when primary ports are unavailable. \u003cbr\u003e Redundancy increases resilience and boosts site reliability scores.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Enabled": { + "name": "Enabled", + "description": "Parameter showing whether redundancy is mandatory. The default is false.", + "json_tag": "enabled" + } + } + }, + "VpicInterface": { + "type_name": "VpicInterface", + "description": "VpicInterface MCN VPIC Interface Information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "The Canonical URL at which the resource resides.", + "json_tag": "href" + }, + "Uuid": { + "name": "Uuid", + "description": "MCN assigned VPIC Interface Identifier", + "json_tag": "uuid" + } + } + }, + "formFile": { + "type_name": "formFile", + "fields": { + "fileBytes": { + "name": "fileBytes", + "description": "" + }, + "fileName": { + "name": "fileName", + "description": "" + }, + "formFileName": { + "name": "formFileName", + "description": "" + } + } + }, + "service": { + "type_name": "service", + "fields": { + "client": { + "name": "client", + "description": "" + } + } + } + } +} \ No newline at end of file diff --git a/cmd/descriptions/lookupv2.json b/cmd/descriptions/lookupv2.json new file mode 100644 index 0000000..f999992 --- /dev/null +++ b/cmd/descriptions/lookupv2.json @@ -0,0 +1,1351 @@ +{ + "services": { + "lookup": { + "service_name": "lookup", + "service_description": "", + "methods": { + "GetLocationsByPermissionCode": { + "short_description": "Get Locations by permission code", + "long_description": "This method retrieves all the user’s IBX locations, accounts, cages and cabinets information according to their ordering permission. This includes A-side and Z-side location information for a cross connect order.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetLocationsByPermissionCodeExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "RetrieveAllPatchPanels": { + "short_description": "Retrieve all patch panels", + "long_description": "This method retrieves all available patch panels associated with a cabinet for a user with cross connects ordering permission.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "RetrieveAllPatchPanelsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "RetrieveListOfConnectionServices": { + "short_description": "Retrieve list of connection services", + "long_description": "This method retrieves a list of supported connection services such as media types, protocol types, connector types and circuit counts.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "RetrieveListOfConnectionServicesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "RetrieveListOfProviders": { + "short_description": "Retrieve list of providers", + "long_description": "This method retrieves all available cross connect service providers to a user with cross connects ordering permission.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "RetrieveListOfProvidersExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "RetrievePatchPanelDetails": { + "short_description": "Retrieve patch panel details", + "long_description": "This method retrieves details of a patch panel by its ID to a user with cross connects ordering permission.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "patchPanelId", + "description": "ID of patch panel" + } + ] + }, + "RetrievePatchPanelDetailsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGetLocationsByPermissionCodeRequest": { + "type_name": "ApiGetLocationsByPermissionCodeRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "aSideIbx": { + "name": "aSideIbx", + "description": "" + }, + "connectionService": { + "name": "connectionService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "details": { + "name": "details", + "description": "" + }, + "ibxs": { + "name": "ibxs", + "description": "" + }, + "permissionCode": { + "name": "permissionCode", + "description": "" + }, + "providerAccountNumber": { + "name": "providerAccountNumber", + "description": "" + } + } + }, + "ApiRetrieveAllPatchPanelsRequest": { + "type_name": "ApiRetrieveAllPatchPanelsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "aSideIbx": { + "name": "aSideIbx", + "description": "" + }, + "accountNumber": { + "name": "accountNumber", + "description": "" + }, + "cabinetId": { + "name": "cabinetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "providerAccountNumber": { + "name": "providerAccountNumber", + "description": "" + } + } + }, + "ApiRetrieveListOfConnectionServicesRequest": { + "type_name": "ApiRetrieveListOfConnectionServicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "ibx": { + "name": "ibx", + "description": "" + } + } + }, + "ApiRetrieveListOfProvidersRequest": { + "type_name": "ApiRetrieveListOfProvidersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "accountNumber": { + "name": "accountNumber", + "description": "" + }, + "cageId": { + "name": "cageId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiRetrievePatchPanelDetailsRequest": { + "type_name": "ApiRetrievePatchPanelDetailsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "aSideIbx": { + "name": "aSideIbx", + "description": "" + }, + "accountNumber": { + "name": "accountNumber", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "patchPanelId": { + "name": "patchPanelId", + "description": "" + }, + "providerAccountNumber": { + "name": "providerAccountNumber", + "description": "" + } + } + } + } + } + }, + "types": { + "APIClient": { + "type_name": "APIClient", + "description": "APIClient manages communication with the Lookup API v2.0\nIn most cases there should be only one, shared, APIClient.", + "fields": { + "LookupApi": { + "name": "LookupApi", + "description": "" + }, + "cfg": { + "name": "cfg", + "description": "" + }, + "common": { + "name": "common", + "description": "Reuse a single struct instead of allocating one for each service on the heap." + } + } + }, + "APIKey": { + "type_name": "APIKey", + "description": "APIKey provides API key based authentication to a request passed via context using ContextAPIKey", + "fields": { + "Key": { + "name": "Key", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "" + } + } + }, + "APIResponse": { + "type_name": "APIResponse", + "description": "APIResponse stores the API response returned by the server.", + "fields": { + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "Method": { + "name": "Method", + "description": "Method is the HTTP method used for the request. This value is always\navailable, even if the embedded *http.Response is nil.", + "json_tag": "method" + }, + "Operation": { + "name": "Operation", + "description": "Operation is the name of the OpenAPI operation.", + "json_tag": "operation" + }, + "Payload": { + "name": "Payload", + "description": "Payload holds the contents of the response body (which may be nil or empty).\nThis is provided here as the raw response.Body() reader will have already\nbeen drained.", + "json_tag": "-" + }, + "RequestURL": { + "name": "RequestURL", + "description": "RequestURL is the request URL. This value is always available, even if the\nembedded *http.Response is nil.", + "json_tag": "url" + } + } + }, + "Accounts": { + "type_name": "Accounts", + "description": "Accounts struct for Accounts", + "fields": { + "AccountName": { + "name": "AccountName", + "description": "Customer account name", + "json_tag": "accountName" + }, + "AccountNumber": { + "name": "AccountNumber", + "description": "Customer account number", + "json_tag": "accountNumber" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AllowOrder": { + "name": "AllowOrder", + "description": "When set to `true`, User is allowed to place an orders on this account", + "json_tag": "allowOrder" + } + } + }, + "ApiGetLocationsByPermissionCodeRequest": { + "type_name": "ApiGetLocationsByPermissionCodeRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "aSideIbx": { + "name": "aSideIbx", + "description": "" + }, + "connectionService": { + "name": "connectionService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "details": { + "name": "details", + "description": "" + }, + "ibxs": { + "name": "ibxs", + "description": "" + }, + "permissionCode": { + "name": "permissionCode", + "description": "" + }, + "providerAccountNumber": { + "name": "providerAccountNumber", + "description": "" + } + } + }, + "ApiRetrieveAllPatchPanelsRequest": { + "type_name": "ApiRetrieveAllPatchPanelsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "aSideIbx": { + "name": "aSideIbx", + "description": "" + }, + "accountNumber": { + "name": "accountNumber", + "description": "" + }, + "cabinetId": { + "name": "cabinetId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "providerAccountNumber": { + "name": "providerAccountNumber", + "description": "" + } + } + }, + "ApiRetrieveListOfConnectionServicesRequest": { + "type_name": "ApiRetrieveListOfConnectionServicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "ibx": { + "name": "ibx", + "description": "" + } + } + }, + "ApiRetrieveListOfProvidersRequest": { + "type_name": "ApiRetrieveListOfProvidersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "accountNumber": { + "name": "accountNumber", + "description": "" + }, + "cageId": { + "name": "cageId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiRetrievePatchPanelDetailsRequest": { + "type_name": "ApiRetrievePatchPanelDetailsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "aSideIbx": { + "name": "aSideIbx", + "description": "" + }, + "accountNumber": { + "name": "accountNumber", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "patchPanelId": { + "name": "patchPanelId", + "description": "" + }, + "providerAccountNumber": { + "name": "providerAccountNumber", + "description": "" + } + } + }, + "BasicAuth": { + "type_name": "BasicAuth", + "description": "BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth", + "fields": { + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "UserName": { + "name": "UserName", + "description": "", + "json_tag": "userName" + } + } + }, + "CageDetails": { + "type_name": "CageDetails", + "description": "CageDetails struct for CageDetails", + "fields": { + "AccountNumbers": { + "name": "AccountNumbers", + "description": "Customer account number associated with cage", + "json_tag": "accountNumbers" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CabinetId": { + "name": "CabinetId", + "description": "Cabinet Unique space id", + "json_tag": "cabinetId" + }, + "CabinetType": { + "name": "CabinetType", + "description": "", + "json_tag": "cabinetType" + }, + "Id": { + "name": "Id", + "description": "Cage Unique space id", + "json_tag": "id" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "Configuration": { + "type_name": "Configuration", + "description": "Configuration stores the configuration of the API client", + "fields": { + "Debug": { + "name": "Debug", + "description": "", + "json_tag": "debug" + }, + "DefaultHeader": { + "name": "DefaultHeader", + "description": "", + "json_tag": "defaultHeader" + }, + "HTTPClient": { + "name": "HTTPClient", + "description": "" + }, + "Host": { + "name": "Host", + "description": "", + "json_tag": "host" + }, + "OperationServers": { + "name": "OperationServers", + "description": "" + }, + "Scheme": { + "name": "Scheme", + "description": "", + "json_tag": "scheme" + }, + "Servers": { + "name": "Servers", + "description": "" + }, + "UserAgent": { + "name": "UserAgent", + "description": "", + "json_tag": "userAgent" + } + } + }, + "ConnectionServicesDetailsInner": { + "type_name": "ConnectionServicesDetailsInner", + "description": "ConnectionServicesDetailsInner struct for ConnectionServicesDetailsInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "MediaTypes": { + "name": "MediaTypes", + "description": "", + "json_tag": "mediaTypes" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "ConnectionServicesDetailsInnerMediaTypesInner": { + "type_name": "ConnectionServicesDetailsInnerMediaTypesInner", + "description": "ConnectionServicesDetailsInnerMediaTypesInner struct for ConnectionServicesDetailsInnerMediaTypesInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CircuitCounts": { + "name": "CircuitCounts", + "description": "Intra-Faciltiy Cable (IFC) circuit count options available for the respective connection service. E.g. If the 'circuitCount' is empty, it means there are no available IFC circuits. If '3,6' appears in the circuit count, it means that the IFC circuits options available are 3 circuits and 6 circuits.", + "json_tag": "circuitCounts" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "ProtocolTypes": { + "name": "ProtocolTypes", + "description": "", + "json_tag": "protocolTypes" + } + } + }, + "ConnectionServicesDetailsInnerMediaTypesInnerProtocolTypesInner": { + "type_name": "ConnectionServicesDetailsInnerMediaTypesInnerProtocolTypesInner", + "description": "ConnectionServicesDetailsInnerMediaTypesInnerProtocolTypesInner struct for ConnectionServicesDetailsInnerMediaTypesInnerProtocolTypesInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ConnectorTypes": { + "name": "ConnectorTypes", + "description": "", + "json_tag": "connectorTypes" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "ErrorDetails": { + "type_name": "ErrorDetails", + "description": "ErrorDetails struct for ErrorDetails", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CorrelationId": { + "name": "CorrelationId", + "description": "", + "json_tag": "correlationId" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "ErrorCode": { + "name": "ErrorCode", + "description": "", + "json_tag": "errorCode" + }, + "ErrorMessage": { + "name": "ErrorMessage", + "description": "", + "json_tag": "errorMessage" + }, + "Help": { + "name": "Help", + "description": "", + "json_tag": "help" + } + } + }, + "GenericOpenAPIError": { + "type_name": "GenericOpenAPIError", + "description": "GenericOpenAPIError Provides access to the body, error and model on returned errors.", + "fields": { + "body": { + "name": "body", + "description": "" + }, + "error": { + "name": "error", + "description": "" + }, + "model": { + "name": "model", + "description": "" + } + } + }, + "LocationsDetails": { + "type_name": "LocationsDetails", + "description": "LocationsDetails struct for LocationsDetails", + "fields": { + "AccessRestricted": { + "name": "AccessRestricted", + "description": "IBX access is restricted when the value is `true`", + "json_tag": "accessRestricted" + }, + "Accounts": { + "name": "Accounts", + "description": "", + "json_tag": "accounts" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cages": { + "name": "Cages", + "description": "", + "json_tag": "cages" + }, + "Ibx": { + "name": "Ibx", + "description": "IBX locations code", + "json_tag": "ibx" + }, + "SpecialPrivilege": { + "name": "SpecialPrivilege", + "description": "When set to `true`, user will be allowed to access IBXs with restricted access. This only applies for specific partners", + "json_tag": "specialPrivilege" + } + } + }, + "LocationsDetailsResponse": { + "type_name": "LocationsDetailsResponse", + "description": "LocationsDetailsResponse struct for LocationsDetailsResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CrossConnects": { + "name": "CrossConnects", + "description": "", + "json_tag": "crossConnects" + } + } + }, + "NullableAccounts": { + "type_name": "NullableAccounts", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBool": { + "type_name": "NullableBool", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCageDetails": { + "type_name": "NullableCageDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCageDetailsCabinetType": { + "type_name": "NullableCageDetailsCabinetType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCageDetailsType": { + "type_name": "NullableCageDetailsType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionServices": { + "type_name": "NullableConnectionServices", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionServicesDetailsInner": { + "type_name": "NullableConnectionServicesDetailsInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionServicesDetailsInnerMediaTypesInner": { + "type_name": "NullableConnectionServicesDetailsInnerMediaTypesInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectionServicesDetailsInnerMediaTypesInnerProtocolTypesInner": { + "type_name": "NullableConnectionServicesDetailsInnerMediaTypesInnerProtocolTypesInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableConnectorTypes": { + "type_name": "NullableConnectorTypes", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableErrorDetails": { + "type_name": "NullableErrorDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat32": { + "type_name": "NullableFloat32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat64": { + "type_name": "NullableFloat64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetLocationsByPermissionCodePermissionCodeParameter": { + "type_name": "NullableGetLocationsByPermissionCodePermissionCodeParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt": { + "type_name": "NullableInt", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt32": { + "type_name": "NullableInt32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt64": { + "type_name": "NullableInt64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLocationsDetails": { + "type_name": "NullableLocationsDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLocationsDetailsResponse": { + "type_name": "NullableLocationsDetailsResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMediaTypes": { + "type_name": "NullableMediaTypes", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePatchPanelDetails": { + "type_name": "NullablePatchPanelDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePatchPanelDetailsInstallLocations": { + "type_name": "NullablePatchPanelDetailsInstallLocations", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePatchPanelDetailsProvisioningType": { + "type_name": "NullablePatchPanelDetailsProvisioningType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePatchPanelDetailsType": { + "type_name": "NullablePatchPanelDetailsType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePatchPanelResponse": { + "type_name": "NullablePatchPanelResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProtocolTypes": { + "type_name": "NullableProtocolTypes", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProvider": { + "type_name": "NullableProvider", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableString": { + "type_name": "NullableString", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTime": { + "type_name": "NullableTime", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUserPortDetails": { + "type_name": "NullableUserPortDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "PatchPanelDetails": { + "type_name": "PatchPanelDetails", + "description": "PatchPanelDetails struct for PatchPanelDetails", + "fields": { + "AccountName": { + "name": "AccountName", + "description": "Customer cage account name", + "json_tag": "accountName" + }, + "AccountNumber": { + "name": "AccountNumber", + "description": "Customer cage account number", + "json_tag": "accountNumber" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AvailablePorts": { + "name": "AvailablePorts", + "description": "Individually identified ports that are available out of the total number of ports.", + "json_tag": "availablePorts" + }, + "CabinetId": { + "name": "CabinetId", + "description": "Cabinet ID", + "json_tag": "cabinetId" + }, + "CageId": { + "name": "CageId", + "description": "Cage ID", + "json_tag": "cageId" + }, + "CircuitAvailable": { + "name": "CircuitAvailable", + "description": "if `true`, circuits are available for patch panel", + "json_tag": "circuitAvailable" + }, + "ConnectionServices": { + "name": "ConnectionServices", + "description": "", + "json_tag": "connectionServices" + }, + "DedicatedMediaType": { + "name": "DedicatedMediaType", + "description": "Type of dedicated media", + "json_tag": "dedicatedMediaType" + }, + "Ibx": { + "name": "Ibx", + "description": "IBX location code", + "json_tag": "ibx" + }, + "IfcEnabled": { + "name": "IfcEnabled", + "description": "Identifies if intra-facility cable (IFC) connection is required for patch panel. When `true`, IFC connection is required.", + "json_tag": "ifcEnabled" + }, + "InstallLocations": { + "name": "InstallLocations", + "description": "", + "json_tag": "installLocations" + }, + "InstallationRequired": { + "name": "InstallationRequired", + "description": "If `true`, Equinix will install cross connect from demarcation panel to customer equipment.", + "json_tag": "installationRequired" + }, + "PatchPanelId": { + "name": "PatchPanelId", + "description": "Patch panel ID / serial number", + "json_tag": "patchPanelId" + }, + "PreWired": { + "name": "PreWired", + "description": "Prewired status of cross connects. When `true`, cross connects are prewired", + "json_tag": "preWired" + }, + "ProvisioningType": { + "name": "ProvisioningType", + "description": "", + "json_tag": "provisioningType" + }, + "RackLocations": { + "name": "RackLocations", + "description": "Rack location of patch panel", + "json_tag": "rackLocations" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UsedPortsDetails": { + "name": "UsedPortsDetails", + "description": "", + "json_tag": "usedPortsDetails" + } + } + }, + "PatchPanelResponse": { + "type_name": "PatchPanelResponse", + "description": "PatchPanelResponse struct for PatchPanelResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AvailablePortCount": { + "name": "AvailablePortCount", + "description": "Available ports for use", + "json_tag": "availablePortCount" + }, + "IfcEnabled": { + "name": "IfcEnabled", + "description": "Patch panel will support only intra facility when `true`", + "json_tag": "ifcEnabled" + }, + "PatchPanelId": { + "name": "PatchPanelId", + "description": "Patch panel unique ID / serial number", + "json_tag": "patchPanelId" + }, + "PatchPanelReferenceId": { + "name": "PatchPanelReferenceId", + "description": "Unique reference ID associated with patch panel", + "json_tag": "patchPanelReferenceId" + }, + "ProvisioningType": { + "name": "ProvisioningType", + "description": "", + "json_tag": "provisioningType" + } + } + }, + "Provider": { + "type_name": "Provider", + "description": "Provider struct for Provider", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ProviderAccountName": { + "name": "ProviderAccountName", + "description": "Cage account name of service provider", + "json_tag": "providerAccountName" + }, + "ProviderAccountNumber": { + "name": "ProviderAccountNumber", + "description": "Cage account number of service provider", + "json_tag": "providerAccountNumber" + } + } + }, + "ServerConfiguration": { + "type_name": "ServerConfiguration", + "description": "ServerConfiguration stores the information about a server", + "fields": { + "Description": { + "name": "Description", + "description": "" + }, + "URL": { + "name": "URL", + "description": "" + }, + "Variables": { + "name": "Variables", + "description": "" + } + } + }, + "ServerVariable": { + "type_name": "ServerVariable", + "description": "ServerVariable stores the information about a server variable", + "fields": { + "DefaultValue": { + "name": "DefaultValue", + "description": "" + }, + "Description": { + "name": "Description", + "description": "" + }, + "EnumValues": { + "name": "EnumValues", + "description": "" + } + } + }, + "UserPortDetails": { + "type_name": "UserPortDetails", + "description": "UserPortDetails struct for UserPortDetails", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CircuitId": { + "name": "CircuitId", + "description": "", + "json_tag": "circuitId" + }, + "ConnectionServicesName": { + "name": "ConnectionServicesName", + "description": "", + "json_tag": "connectionServicesName" + }, + "PortNumber": { + "name": "PortNumber", + "description": "Port number that is currently in use", + "json_tag": "portNumber" + }, + "SerialNumber": { + "name": "SerialNumber", + "description": "Serial number or cable id", + "json_tag": "serialNumber" + }, + "ZSideProviderName": { + "name": "ZSideProviderName", + "description": "Name of Z-Side service provider", + "json_tag": "zSideProviderName" + } + } + }, + "formFile": { + "type_name": "formFile", + "fields": { + "fileBytes": { + "name": "fileBytes", + "description": "" + }, + "fileName": { + "name": "fileName", + "description": "" + }, + "formFileName": { + "name": "formFileName", + "description": "" + } + } + }, + "service": { + "type_name": "service", + "fields": { + "client": { + "name": "client", + "description": "" + } + } + } + } +} \ No newline at end of file diff --git a/cmd/descriptions/metalv1.json b/cmd/descriptions/metalv1.json new file mode 100644 index 0000000..f3f9827 --- /dev/null +++ b/cmd/descriptions/metalv1.json @@ -0,0 +1,29092 @@ +{ + "services": { + "authentication": { + "service_name": "authentication", + "service_description": "", + "methods": { + "CreateAPIKey": { + "short_description": "Create an API key", + "long_description": "Creates a API key for the current user.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateAPIKeyExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateProjectAPIKey": { + "short_description": "Create an API key for a project.", + "long_description": "Creates an API key for a project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "CreateProjectAPIKeyExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteAPIKey": { + "short_description": "Delete the API key", + "long_description": "Deletes the API key.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "API Key UUID" + } + ] + }, + "DeleteAPIKeyExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteUserAPIKey": { + "short_description": "Delete the API key", + "long_description": "Deletes the current user API key.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "API Key UUID" + } + ] + }, + "DeleteUserAPIKeyExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindAPIKeys": { + "short_description": "Retrieve all user API keys", + "long_description": "Returns all API keys for the current user.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindAPIKeysExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectAPIKeys": { + "short_description": "Retrieve all API keys for the project.", + "long_description": "Returns all API keys for a specific project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindProjectAPIKeysExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateAPIKeyRequest": { + "type_name": "ApiCreateAPIKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authTokenInput": { + "name": "authTokenInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCreateProjectAPIKeyRequest": { + "type_name": "ApiCreateProjectAPIKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authTokenInput": { + "name": "authTokenInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDeleteAPIKeyRequest": { + "type_name": "ApiDeleteAPIKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteUserAPIKeyRequest": { + "type_name": "ApiDeleteUserAPIKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindAPIKeysRequest": { + "type_name": "ApiFindAPIKeysRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "search": { + "name": "search", + "description": "" + } + } + }, + "ApiFindProjectAPIKeysRequest": { + "type_name": "ApiFindProjectAPIKeysRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + } + } + }, + "batches": { + "service_name": "batches", + "service_description": "", + "methods": { + "CreateDeviceBatch": { + "short_description": "Create a devices batch", + "long_description": "Creates new devices in batch and provisions them in our datacenter.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "CreateDeviceBatchExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteBatch": { + "short_description": "Delete the Batch", + "long_description": "Deletes the Batch.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Batch UUID" + } + ] + }, + "DeleteBatchExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindBatchById": { + "short_description": "Retrieve a Batch", + "long_description": "Returns a Batch", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Batch UUID" + } + ] + }, + "FindBatchByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindBatchesByProject": { + "short_description": "Retrieve all batches by project", + "long_description": "Returns all batches for the given project", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindBatchesByProjectExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateDeviceBatchRequest": { + "type_name": "ApiCreateDeviceBatchRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "instancesBatchCreateInput": { + "name": "instancesBatchCreateInput", + "description": "" + } + } + }, + "ApiDeleteBatchRequest": { + "type_name": "ApiDeleteBatchRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "removeAssociatedInstances": { + "name": "removeAssociatedInstances", + "description": "" + } + } + }, + "ApiFindBatchByIdRequest": { + "type_name": "ApiFindBatchByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindBatchesByProjectRequest": { + "type_name": "ApiFindBatchesByProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + } + } + }, + "bgp": { + "service_name": "bgp", + "service_description": "", + "methods": { + "DeleteBgpSession": { + "short_description": "Delete the BGP session", + "long_description": "Deletes the BGP session.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "BGP session UUID" + } + ] + }, + "DeleteBgpSessionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindBgpConfigByProject": { + "short_description": "Retrieve a bgp config", + "long_description": "Returns a bgp config", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindBgpConfigByProjectExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindBgpSessionById": { + "short_description": "Retrieve a BGP session", + "long_description": "Returns a BGP session", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "BGP session UUID" + } + ] + }, + "FindBgpSessionByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindGlobalBgpRanges": { + "short_description": "Retrieve all global bgp ranges", + "long_description": "Returns all global bgp ranges for a project", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindGlobalBgpRangesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectBgpSessions": { + "short_description": "Retrieve all BGP sessions for project", + "long_description": "Provides a listing of available BGP sessions for the project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindProjectBgpSessionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "RequestBgpConfig": { + "short_description": "Requesting bgp config", + "long_description": "Requests to enable bgp configuration for a project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "RequestBgpConfigExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateBgpSession": { + "short_description": "Update the BGP session", + "long_description": "Updates the BGP session by either enabling or disabling the default route functionality.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "BGP session UUID" + } + ] + }, + "UpdateBgpSessionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiDeleteBgpSessionRequest": { + "type_name": "ApiDeleteBgpSessionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindBgpConfigByProjectRequest": { + "type_name": "ApiFindBgpConfigByProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindBgpSessionByIdRequest": { + "type_name": "ApiFindBgpSessionByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindGlobalBgpRangesRequest": { + "type_name": "ApiFindGlobalBgpRangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindProjectBgpSessionsRequest": { + "type_name": "ApiFindProjectBgpSessionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiRequestBgpConfigRequest": { + "type_name": "ApiRequestBgpConfigRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bgpConfigRequestInput": { + "name": "bgpConfigRequestInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiUpdateBgpSessionRequest": { + "type_name": "ApiUpdateBgpSessionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + } + } + }, + "capacity": { + "service_name": "capacity", + "service_description": "", + "methods": { + "CheckCapacityForFacility": { + "short_description": "Check capacity", + "long_description": "Validates if a deploy can be fulfilled. Deprecated", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CheckCapacityForFacilityExecute": { + "short_description": "Execute executes the request", + "long_description": "Deprecated" + }, + "CheckCapacityForMetro": { + "short_description": "Check capacity for a metro", + "long_description": "Validates if a deploy can be fulfilled in a metro.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CheckCapacityForMetroExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindCapacityForFacility": { + "short_description": "View capacity", + "long_description": "Returns a list of facilities and plans with their current capacity.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindCapacityForFacilityExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindCapacityForMetro": { + "short_description": "View capacity for metros", + "long_description": "Returns a list of metros and plans with their current capacity.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindCapacityForMetroExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOrganizationCapacityPerFacility": { + "short_description": "View available hardware plans per Facility for given organization", + "long_description": "Returns a list of facilities and plans with their current capacity.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOrganizationCapacityPerFacilityExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOrganizationCapacityPerMetro": { + "short_description": "View available hardware plans per Metro for given organization", + "long_description": "Returns a list of metros and plans with their current capacity.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOrganizationCapacityPerMetroExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCheckCapacityForFacilityRequest": { + "type_name": "ApiCheckCapacityForFacilityRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "capacityInput": { + "name": "capacityInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiCheckCapacityForMetroRequest": { + "type_name": "ApiCheckCapacityForMetroRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "capacityInput": { + "name": "capacityInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiFindCapacityForFacilityRequest": { + "type_name": "ApiFindCapacityForFacilityRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiFindCapacityForMetroRequest": { + "type_name": "ApiFindCapacityForMetroRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiFindOrganizationCapacityPerFacilityRequest": { + "type_name": "ApiFindOrganizationCapacityPerFacilityRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindOrganizationCapacityPerMetroRequest": { + "type_name": "ApiFindOrganizationCapacityPerMetroRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + } + } + }, + "console-log-details": { + "service_name": "console-log-details", + "service_description": "", + "methods": { + "CaptureScreenshot": { + "short_description": "Method for CaptureScreenshot", + "long_description": "Capture a screenshot from the device, if supported, via the BMC.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "CaptureScreenshotExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCaptureScreenshotRequest": { + "type_name": "ApiCaptureScreenshotRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + } + } + }, + "devices": { + "service_name": "devices", + "service_description": "", + "methods": { + "CreateBgpSession": { + "short_description": "Create a BGP session", + "long_description": "Creates a BGP session.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "CreateBgpSessionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateDevice": { + "short_description": "Create a device", + "long_description": "Creates a new device and provisions it in the specified location. Device type-specific options are accepted. For example, `baremetal` devices accept `operating_system`, `hostname`, and `plan`. These parameters may not be accepted for other device types. The default device type is `baremetal`.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "CreateDeviceExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateIPAssignment": { + "short_description": "Create an ip assignment", + "long_description": "Creates an ip assignment for a device.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "CreateIPAssignmentExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteDevice": { + "short_description": "Delete the device", + "long_description": "Deletes a device and deprovisions it in our datacenter.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "DeleteDeviceExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindBgpSessions": { + "short_description": "Retrieve all BGP sessions", + "long_description": "Provides a listing of available BGP sessions for the device.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "FindBgpSessionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindDeviceById": { + "short_description": "Retrieve a device", + "long_description": "Type-specific options (such as facility for baremetal devices) will be included as part of the main data structure. State value can be one of: active inactive queued or provisioning", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "FindDeviceByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindDeviceCustomdata": { + "short_description": "Retrieve the custom metadata of an instance", + "long_description": "Provides the custom metadata stored for this instance in json format", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Instance UUID" + } + ] + }, + "FindDeviceCustomdataExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindDeviceMetadataByID": { + "short_description": "Retrieve metadata", + "long_description": "Retrieve device metadata", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "FindDeviceMetadataByIDExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindDeviceUserdataByID": { + "short_description": "Retrieve userdata", + "long_description": "Retrieve device userdata", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "FindDeviceUserdataByIDExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindIPAssignmentCustomdata": { + "short_description": "Retrieve the custom metadata of an IP Assignment", + "long_description": "Provides the custom metadata stored for this IP Assignment in json format", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "instanceId", + "description": "Instance UUID" + }, + { + "name": "id", + "description": "Ip Assignment UUID" + } + ] + }, + "FindIPAssignmentCustomdataExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindIPAssignments": { + "short_description": "Retrieve all ip assignments", + "long_description": "Returns all ip assignments for a device.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "FindIPAssignmentsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindInstanceBandwidth": { + "short_description": "Retrieve an instance bandwidth", + "long_description": "Retrieve an instance bandwidth for a given period of time.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "FindInstanceBandwidthExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOrganizationDevices": { + "short_description": "Retrieve all devices of an organization", + "long_description": "Provides a collection of devices for a given organization.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOrganizationDevicesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectDevices": { + "short_description": "Retrieve all devices of a project", + "long_description": "Provides a collection of devices for a given project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindProjectDevicesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindTraffic": { + "short_description": "Retrieve device traffic", + "long_description": "Returns the total amount of inbound or outbound traffic for a specific device. The default time period is 1 hour. Please note the results capture all network traffic for the server, but not all traffic may come from or be destined to the Internet and may be non-billable. Only Internet bound traffic is charged.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "FindTrafficExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetBgpNeighborData": { + "short_description": "Retrieve BGP neighbor data for this device", + "long_description": "Provides a summary of the BGP neighbor data associated to the BGP sessions for this device.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "GetBgpNeighborDataExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetDeviceFirmwareSets": { + "short_description": "Get Device's associated Firmware Set", + "long_description": "Returns the firmware set associated with the device. If a custom firmware set is associated with the device, then it is returned. Otherwise, if a default firmware set is available it is returned.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "GetDeviceFirmwareSetsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetDeviceHealthRollup": { + "short_description": "Get Device's Health Status", + "long_description": "Returns the health rollup status of the device.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "GetDeviceHealthRollupExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "PerformAction": { + "short_description": "Perform an action", + "long_description": "Performs an action for the given device. Possible actions include: power_on, power_off, reboot, reinstall, and rescue (reboot the device into rescue OS.)", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "PerformActionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateDevice": { + "short_description": "Update the device", + "long_description": "Updates the device.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "UpdateDeviceExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateBgpSessionRequest": { + "type_name": "ApiCreateBgpSessionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bGPSessionInput": { + "name": "bGPSessionInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCreateDeviceRequest": { + "type_name": "ApiCreateDeviceRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createDeviceRequest": { + "name": "createDeviceRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCreateIPAssignmentRequest": { + "type_name": "ApiCreateIPAssignmentRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "iPAssignmentInput": { + "name": "iPAssignmentInput", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDeleteDeviceRequest": { + "type_name": "ApiDeleteDeviceRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "forceDelete": { + "name": "forceDelete", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindBgpSessionsRequest": { + "type_name": "ApiFindBgpSessionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindDeviceByIdRequest": { + "type_name": "ApiFindDeviceByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindDeviceCustomdataRequest": { + "type_name": "ApiFindDeviceCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindDeviceMetadataByIDRequest": { + "type_name": "ApiFindDeviceMetadataByIDRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindDeviceUserdataByIDRequest": { + "type_name": "ApiFindDeviceUserdataByIDRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindIPAssignmentCustomdataRequest": { + "type_name": "ApiFindIPAssignmentCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "instanceId": { + "name": "instanceId", + "description": "" + } + } + }, + "ApiFindIPAssignmentsRequest": { + "type_name": "ApiFindIPAssignmentsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindInstanceBandwidthRequest": { + "type_name": "ApiFindInstanceBandwidthRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "from": { + "name": "from", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "until": { + "name": "until", + "description": "" + } + } + }, + "ApiFindOrganizationDevicesRequest": { + "type_name": "ApiFindOrganizationDevicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "categories": { + "name": "categories", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "facility": { + "name": "facility", + "description": "" + }, + "hasTerminationTime": { + "name": "hasTerminationTime", + "description": "" + }, + "hostname": { + "name": "hostname", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "macAddress": { + "name": "macAddress", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "reserved": { + "name": "reserved", + "description": "" + }, + "search": { + "name": "search", + "description": "" + }, + "tag": { + "name": "tag", + "description": "" + }, + "type_": { + "name": "type_", + "description": "" + } + } + }, + "ApiFindProjectDevicesRequest": { + "type_name": "ApiFindProjectDevicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "categories": { + "name": "categories", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "facility": { + "name": "facility", + "description": "" + }, + "hasTerminationTime": { + "name": "hasTerminationTime", + "description": "" + }, + "hostname": { + "name": "hostname", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "macAddress": { + "name": "macAddress", + "description": "" + }, + "metro": { + "name": "metro", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "reserved": { + "name": "reserved", + "description": "" + }, + "search": { + "name": "search", + "description": "" + }, + "tag": { + "name": "tag", + "description": "" + }, + "type_": { + "name": "type_", + "description": "" + } + } + }, + "ApiFindTrafficRequest": { + "type_name": "ApiFindTrafficRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bucket": { + "name": "bucket", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "direction": { + "name": "direction", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "interval": { + "name": "interval", + "description": "" + }, + "timeframe": { + "name": "timeframe", + "description": "" + } + } + }, + "ApiGetBgpNeighborDataRequest": { + "type_name": "ApiGetBgpNeighborDataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetDeviceFirmwareSetsRequest": { + "type_name": "ApiGetDeviceFirmwareSetsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiGetDeviceHealthRollupRequest": { + "type_name": "ApiGetDeviceHealthRollupRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiPerformActionRequest": { + "type_name": "ApiPerformActionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "deviceActionInput": { + "name": "deviceActionInput", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiUpdateDeviceRequest": { + "type_name": "ApiUpdateDeviceRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "deviceUpdateInput": { + "name": "deviceUpdateInput", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + } + } + }, + "emails": { + "service_name": "emails", + "service_description": "", + "methods": { + "CreateEmail": { + "short_description": "Create an email", + "long_description": "Add a new email address to the current user. Deprecated", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateEmailExecute": { + "short_description": "Execute executes the request", + "long_description": "Deprecated" + }, + "DeleteEmail": { + "short_description": "Delete the email", + "long_description": "Deletes the email.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Email UUID" + } + ] + }, + "DeleteEmailExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindEmailById": { + "short_description": "Retrieve an email", + "long_description": "Provides one of the user’s emails.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Email UUID" + } + ] + }, + "FindEmailByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateEmail": { + "short_description": "Update the email", + "long_description": "Updates the email.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Email UUID" + } + ] + }, + "UpdateEmailExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateEmailRequest": { + "type_name": "ApiCreateEmailRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createEmailInput": { + "name": "createEmailInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiDeleteEmailRequest": { + "type_name": "ApiDeleteEmailRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindEmailByIdRequest": { + "type_name": "ApiFindEmailByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiUpdateEmailRequest": { + "type_name": "ApiUpdateEmailRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "updateEmailInput": { + "name": "updateEmailInput", + "description": "" + } + } + } + } + }, + "events": { + "service_name": "events", + "service_description": "", + "methods": { + "FindDeviceEvents": { + "short_description": "Retrieve device's events", + "long_description": "Returns a list of events pertaining to a specific device", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "FindDeviceEventsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindEventById": { + "short_description": "Retrieve an event", + "long_description": "Returns a single event if the user has access", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Event UUID" + } + ] + }, + "FindEventByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindEvents": { + "short_description": "Retrieve current user's events", + "long_description": "Returns a list of the current user’s events", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindEventsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindInterconnectionEvents": { + "short_description": "Retrieve interconnection events", + "long_description": "Returns a list of the interconnection events", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Interconnection UUID" + } + ] + }, + "FindInterconnectionEventsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindInterconnectionPortEvents": { + "short_description": "Retrieve interconnection port events", + "long_description": "Returns a list of the interconnection port events", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Interconnection UUID" + }, + { + "name": "id", + "description": "Interconnection Port UUID" + } + ] + }, + "FindInterconnectionPortEventsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOrganizationEvents": { + "short_description": "Retrieve organization's events", + "long_description": "Returns a list of events for a single organization", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOrganizationEventsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectEvents": { + "short_description": "Retrieve project's events", + "long_description": "Returns a list of events for a single project", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindProjectEventsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindVirtualCircuitEvents": { + "short_description": "Retrieve virtual circuit events", + "long_description": "Returns a list of the virtual circuit events", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Virtual Circuit UUID" + } + ] + }, + "FindVirtualCircuitEventsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindVrfRouteEvents": { + "short_description": "Retrieve VRF route events", + "long_description": "Returns a list of the VRF route events", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF Route UUID" + } + ] + }, + "FindVrfRouteEventsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiFindDeviceEventsRequest": { + "type_name": "ApiFindDeviceEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindEventByIdRequest": { + "type_name": "ApiFindEventByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindEventsRequest": { + "type_name": "ApiFindEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindInterconnectionEventsRequest": { + "type_name": "ApiFindInterconnectionEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindInterconnectionPortEventsRequest": { + "type_name": "ApiFindInterconnectionPortEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindOrganizationEventsRequest": { + "type_name": "ApiFindOrganizationEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindProjectEventsRequest": { + "type_name": "ApiFindProjectEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindVirtualCircuitEventsRequest": { + "type_name": "ApiFindVirtualCircuitEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindVrfRouteEventsRequest": { + "type_name": "ApiFindVrfRouteEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + } + } + }, + "facilities": { + "service_name": "facilities", + "service_description": "", + "methods": { + "FindFacilities": { + "short_description": "Retrieve all facilities", + "long_description": "Provides a listing of available datacenters where you can provision Packet devices. Deprecated", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindFacilitiesByOrganization": { + "short_description": "Retrieve all facilities visible by the organization", + "long_description": "Returns a listing of available datacenters for the given organization Deprecated", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindFacilitiesByOrganizationExecute": { + "short_description": "Execute executes the request", + "long_description": "Deprecated" + }, + "FindFacilitiesByProject": { + "short_description": "Retrieve all facilities visible by the project", + "long_description": "Returns a listing of available datacenters for the given project Deprecated", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindFacilitiesByProjectExecute": { + "short_description": "Execute executes the request", + "long_description": "Deprecated" + }, + "FindFacilitiesExecute": { + "short_description": "Execute executes the request", + "long_description": "Deprecated" + } + }, + "types": { + "ApiFindFacilitiesByOrganizationRequest": { + "type_name": "ApiFindFacilitiesByOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindFacilitiesByProjectRequest": { + "type_name": "ApiFindFacilitiesByProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindFacilitiesRequest": { + "type_name": "ApiFindFacilitiesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + } + } + }, + "firmware-sets": { + "service_name": "firmware-sets", + "service_description": "", + "methods": { + "GetOrganizationFirmwareSets": { + "short_description": "Get Organization's Firmware Sets", + "long_description": "Returns all firmware sets associated with the organization.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "GetOrganizationFirmwareSetsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetProjectFirmwareSets": { + "short_description": "Get Project's Firmware Sets", + "long_description": "Returns all firmware sets associated with the project or organization.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "GetProjectFirmwareSetsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGetOrganizationFirmwareSetsRequest": { + "type_name": "ApiGetOrganizationFirmwareSetsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiGetProjectFirmwareSetsRequest": { + "type_name": "ApiGetProjectFirmwareSetsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + } + } + }, + "hardware-reservations": { + "service_name": "hardware-reservations", + "service_description": "", + "methods": { + "ActivateHardwareReservation": { + "short_description": "Activate a spare hardware reservation", + "long_description": "Activate a spare hardware reservation", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Hardware Reservation UUID" + } + ] + }, + "ActivateHardwareReservationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindHardwareReservationById": { + "short_description": "Retrieve a hardware reservation", + "long_description": "Returns a single hardware reservation", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "HardwareReservation UUID" + } + ] + }, + "FindHardwareReservationByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectHardwareReservations": { + "short_description": "Retrieve all hardware reservations for a given project", + "long_description": "Provides a collection of hardware reservations for a given project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindProjectHardwareReservationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "MoveHardwareReservation": { + "short_description": "Move a hardware reservation", + "long_description": "Move a hardware reservation to another project", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Hardware Reservation UUID" + } + ] + }, + "MoveHardwareReservationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiActivateHardwareReservationRequest": { + "type_name": "ApiActivateHardwareReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "activateHardwareReservationRequest": { + "name": "activateHardwareReservationRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindHardwareReservationByIdRequest": { + "type_name": "ApiFindHardwareReservationByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindProjectHardwareReservationsRequest": { + "type_name": "ApiFindProjectHardwareReservationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "provisionable": { + "name": "provisionable", + "description": "" + }, + "query": { + "name": "query", + "description": "" + }, + "state": { + "name": "state", + "description": "" + } + } + }, + "ApiMoveHardwareReservationRequest": { + "type_name": "ApiMoveHardwareReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "moveHardwareReservationRequest": { + "name": "moveHardwareReservationRequest", + "description": "" + } + } + } + } + }, + "incidents": { + "service_name": "incidents", + "service_description": "", + "methods": { + "FindIncidents": { + "short_description": "Retrieve the number of incidents", + "long_description": "Retrieve the number of incidents.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindIncidentsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiFindIncidentsRequest": { + "type_name": "ApiFindIncidentsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + } + } + }, + "interconnections": { + "service_name": "interconnections", + "service_description": "", + "methods": { + "CreateInterconnectionPortVirtualCircuit": { + "short_description": "Create a new Virtual Circuit", + "long_description": "Create a new Virtual Circuit on a Dedicated Port. To create a regular Virtual Circuit, specify a Virtual Network record and an NNI VLAN value. To create a VRF-based Virtual Circuit, specify the VRF ID and subnet, along with the NNI VLAN value.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "UUID of the interconnection" + }, + { + "name": "portId", + "description": "UUID of the interconnection port" + } + ] + }, + "CreateInterconnectionPortVirtualCircuitExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateOrganizationInterconnection": { + "short_description": "Request a new interconnection for the organization", + "long_description": "Creates a new interconnection request. A Project ID must be specified in the request body for connections on shared ports.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "organizationId", + "description": "UUID of the organization" + } + ] + }, + "CreateOrganizationInterconnectionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateProjectInterconnection": { + "short_description": "Request a new interconnection for the project's organization", + "long_description": "Creates a new interconnection request", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "projectId", + "description": "UUID of the project" + } + ] + }, + "CreateProjectInterconnectionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteInterconnection": { + "short_description": "Delete interconnection", + "long_description": "Delete a interconnection, its associated ports and virtual circuits.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Interconnection UUID" + } + ] + }, + "DeleteInterconnectionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteVirtualCircuit": { + "short_description": "Delete a virtual circuit", + "long_description": "Delete a virtual circuit from a Dedicated Port.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Virtual Circuit UUID" + } + ] + }, + "DeleteVirtualCircuitExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetInterconnection": { + "short_description": "Get interconnection", + "long_description": "Get the details of a interconnection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Interconnection UUID" + } + ] + }, + "GetInterconnectionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetInterconnectionMetros": { + "short_description": "Get connectivity to network provider by metro", + "long_description": "Displays which providers you can connect to directly from Equinix Metal Metros.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetInterconnectionMetrosExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetInterconnectionPort": { + "short_description": "Get a interconnection port", + "long_description": "Get the details of an interconnection port.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "UUID of the interconnection" + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "GetInterconnectionPortExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetInterconnectionPricing": { + "short_description": "Get Interconnection Pricing", + "long_description": "Displays pricing information for connecting to networks outside of Equinix.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetInterconnectionPricingExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetVirtualCircuit": { + "short_description": "Get a virtual circuit", + "long_description": "Get the details of a virtual circuit", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Virtual Circuit UUID" + } + ] + }, + "GetVirtualCircuitExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ListInterconnectionPortVirtualCircuits": { + "short_description": "List a interconnection port's virtual circuits", + "long_description": "List the virtual circuit record(s) associatiated with a particular interconnection port.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "UUID of the interconnection" + }, + { + "name": "portId", + "description": "UUID of the interconnection port" + } + ] + }, + "ListInterconnectionPortVirtualCircuitsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ListInterconnectionPorts": { + "short_description": "List a interconnection's ports", + "long_description": "List the ports associated to an interconnection.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "UUID of the interconnection" + } + ] + }, + "ListInterconnectionPortsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ListInterconnectionVirtualCircuits": { + "short_description": "List a interconnection's virtual circuits", + "long_description": "List the virtual circuit record(s) associated with a particular interconnection id.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "UUID of the interconnection" + } + ] + }, + "ListInterconnectionVirtualCircuitsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "OrganizationListInterconnections": { + "short_description": "List organization connections", + "long_description": "List the connections belonging to the organization", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "organizationId", + "description": "UUID of the organization" + } + ] + }, + "OrganizationListInterconnectionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ProjectListInterconnections": { + "short_description": "List project connections", + "long_description": "List the connections belonging to the project", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "projectId", + "description": "UUID of the project" + } + ] + }, + "ProjectListInterconnectionsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateInterconnection": { + "short_description": "Update interconnection", + "long_description": "Update the details of a interconnection", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "connectionId", + "description": "Interconnection UUID" + } + ] + }, + "UpdateInterconnectionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateVirtualCircuit": { + "short_description": "Update a virtual circuit", + "long_description": "Update the details of a virtual circuit.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Virtual Circuit UUID" + } + ] + }, + "UpdateVirtualCircuitExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateInterconnectionPortVirtualCircuitRequest": { + "type_name": "ApiCreateInterconnectionPortVirtualCircuitRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + }, + "virtualCircuitCreateInput": { + "name": "virtualCircuitCreateInput", + "description": "" + } + } + }, + "ApiCreateOrganizationInterconnectionRequest": { + "type_name": "ApiCreateOrganizationInterconnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createOrganizationInterconnectionRequest": { + "name": "createOrganizationInterconnectionRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "organizationId": { + "name": "organizationId", + "description": "" + } + } + }, + "ApiCreateProjectInterconnectionRequest": { + "type_name": "ApiCreateProjectInterconnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createOrganizationInterconnectionRequest": { + "name": "createOrganizationInterconnectionRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiDeleteInterconnectionRequest": { + "type_name": "ApiDeleteInterconnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDeleteVirtualCircuitRequest": { + "type_name": "ApiDeleteVirtualCircuitRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetInterconnectionMetrosRequest": { + "type_name": "ApiGetInterconnectionMetrosRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetInterconnectionPortRequest": { + "type_name": "ApiGetInterconnectionPortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetInterconnectionPricingRequest": { + "type_name": "ApiGetInterconnectionPricingRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetInterconnectionRequest": { + "type_name": "ApiGetInterconnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetVirtualCircuitRequest": { + "type_name": "ApiGetVirtualCircuitRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiListInterconnectionPortVirtualCircuitsRequest": { + "type_name": "ApiListInterconnectionPortVirtualCircuitsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + } + } + }, + "ApiListInterconnectionPortsRequest": { + "type_name": "ApiListInterconnectionPortsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiListInterconnectionVirtualCircuitsRequest": { + "type_name": "ApiListInterconnectionVirtualCircuitsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiOrganizationListInterconnectionsRequest": { + "type_name": "ApiOrganizationListInterconnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "organizationId": { + "name": "organizationId", + "description": "" + } + } + }, + "ApiProjectListInterconnectionsRequest": { + "type_name": "ApiProjectListInterconnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiUpdateInterconnectionRequest": { + "type_name": "ApiUpdateInterconnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "interconnectionUpdateInput": { + "name": "interconnectionUpdateInput", + "description": "" + } + } + }, + "ApiUpdateVirtualCircuitRequest": { + "type_name": "ApiUpdateVirtualCircuitRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "virtualCircuitUpdateInput": { + "name": "virtualCircuitUpdateInput", + "description": "" + } + } + } + } + }, + "invitations": { + "service_name": "invitations", + "service_description": "", + "methods": { + "AcceptInvitation": { + "short_description": "Accept an invitation", + "long_description": "Accept an invitation.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Invitation UUID" + } + ] + }, + "AcceptInvitationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeclineInvitation": { + "short_description": "Decline an invitation", + "long_description": "Decline an invitation.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Invitation UUID" + } + ] + }, + "DeclineInvitationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindInvitationById": { + "short_description": "View an invitation", + "long_description": "Returns a single invitation. (It include the `invitable` to maintain backward compatibility but will be removed soon)", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Invitation UUID" + } + ] + }, + "FindInvitationByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiAcceptInvitationRequest": { + "type_name": "ApiAcceptInvitationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDeclineInvitationRequest": { + "type_name": "ApiDeclineInvitationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindInvitationByIdRequest": { + "type_name": "ApiFindInvitationByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + } + } + }, + "invoices": { + "service_name": "invoices", + "service_description": "", + "methods": { + "FindOrganizationInvoices": { + "short_description": "Retrieve all invoices for an organization", + "long_description": "Returns all invoices for an organization", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOrganizationInvoicesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetInvoiceById": { + "short_description": "Retrieve an invoice", + "long_description": "Returns the invoice identified by the provided id", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Invoice UUID" + } + ] + }, + "GetInvoiceByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiFindOrganizationInvoicesRequest": { + "type_name": "ApiFindOrganizationInvoicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "status": { + "name": "status", + "description": "" + } + } + }, + "ApiGetInvoiceByIdRequest": { + "type_name": "ApiGetInvoiceByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + } + } + }, + "ip-addresses": { + "service_name": "ip-addresses", + "service_description": "", + "methods": { + "DeleteIPAddress": { + "short_description": "Unassign an ip address", + "long_description": "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.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "IP Address UUID" + } + ] + }, + "DeleteIPAddressExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindIPAddressById": { + "short_description": "Retrieve an ip address", + "long_description": "Returns a single ip address if the user has access.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "IP Address UUID" + } + ] + }, + "FindIPAddressByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindIPAddressCustomdata": { + "short_description": "Retrieve the custom metadata of an IP Reservation or IP Assignment", + "long_description": "Provides the custom metadata stored for this IP Reservation or IP Assignment in json format", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Ip Reservation UUID" + } + ] + }, + "FindIPAddressCustomdataExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindIPAvailabilities": { + "short_description": "Retrieve all available subnets of a particular reservation", + "long_description": "Provides a list of IP resevations for a single project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "IP Reservation UUID" + } + ] + }, + "FindIPAvailabilitiesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindIPReservations": { + "short_description": "Retrieve all ip reservations", + "long_description": "Provides a paginated list of IP reservations for a single project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindIPReservationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "RequestIPReservation": { + "short_description": "Requesting IP reservations", + "long_description": "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.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "RequestIPReservationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateIPAddress": { + "short_description": "Update an ip address", + "long_description": "Update details about an ip address", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "IP Address UUID" + } + ] + }, + "UpdateIPAddressExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiDeleteIPAddressRequest": { + "type_name": "ApiDeleteIPAddressRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindIPAddressByIdRequest": { + "type_name": "ApiFindIPAddressByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindIPAddressCustomdataRequest": { + "type_name": "ApiFindIPAddressCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindIPAvailabilitiesRequest": { + "type_name": "ApiFindIPAvailabilitiesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cidr": { + "name": "cidr", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindIPReservationsRequest": { + "type_name": "ApiFindIPReservationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "types": { + "name": "types", + "description": "" + } + } + }, + "ApiRequestIPReservationRequest": { + "type_name": "ApiRequestIPReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "requestIPReservationRequest": { + "name": "requestIPReservationRequest", + "description": "" + } + } + }, + "ApiUpdateIPAddressRequest": { + "type_name": "ApiUpdateIPAddressRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "iPAssignmentUpdateInput": { + "name": "iPAssignmentUpdateInput", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + } + } + }, + "licenses": { + "service_name": "licenses", + "service_description": "", + "methods": { + "CreateLicense": { + "short_description": "Create a License", + "long_description": "Creates a new license for the given project", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "CreateLicenseExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteLicense": { + "short_description": "Delete the license", + "long_description": "Deletes a license.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "License UUID" + } + ] + }, + "DeleteLicenseExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindLicenseById": { + "short_description": "Retrieve a license", + "long_description": "Returns a license", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "License UUID" + } + ] + }, + "FindLicenseByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectLicenses": { + "short_description": "Retrieve all licenses", + "long_description": "Provides a collection of licenses for a given project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindProjectLicensesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateLicense": { + "short_description": "Update the license", + "long_description": "Updates the license.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "License UUID" + } + ] + }, + "UpdateLicenseExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateLicenseRequest": { + "type_name": "ApiCreateLicenseRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "licenseCreateInput": { + "name": "licenseCreateInput", + "description": "" + } + } + }, + "ApiDeleteLicenseRequest": { + "type_name": "ApiDeleteLicenseRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindLicenseByIdRequest": { + "type_name": "ApiFindLicenseByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindProjectLicensesRequest": { + "type_name": "ApiFindProjectLicensesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiUpdateLicenseRequest": { + "type_name": "ApiUpdateLicenseRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "licenseUpdateInput": { + "name": "licenseUpdateInput", + "description": "" + } + } + } + } + }, + "memberships": { + "service_name": "memberships", + "service_description": "", + "methods": { + "DeleteMembership": { + "short_description": "Delete the membership", + "long_description": "Deletes the membership.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Membership UUID" + } + ] + }, + "DeleteMembershipExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindMembershipById": { + "short_description": "Retrieve a membership", + "long_description": "Returns a single membership.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Membership UUID" + } + ] + }, + "FindMembershipByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateMembership": { + "short_description": "Update the membership", + "long_description": "Updates the membership.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Membership UUID" + } + ] + }, + "UpdateMembershipExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiDeleteMembershipRequest": { + "type_name": "ApiDeleteMembershipRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindMembershipByIdRequest": { + "type_name": "ApiFindMembershipByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiUpdateMembershipRequest": { + "type_name": "ApiUpdateMembershipRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "membershipInput": { + "name": "membershipInput", + "description": "" + } + } + } + } + }, + "metal-gateways": { + "service_name": "metal-gateways", + "service_description": "", + "methods": { + "CreateBgpDynamicNeighbor": { + "short_description": "Create a VRF BGP Dynamic Neighbor range", + "long_description": "Create a VRF BGP Dynamic Neighbor range. BGP Dynamic Neighbor records are limited to 2 per Virtual Network.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Metal Gateway UUID" + } + ] + }, + "CreateBgpDynamicNeighborExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateMetalGateway": { + "short_description": "Create a metal gateway", + "long_description": "Create a metal gateway in a project", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "projectId", + "description": "Project UUID" + } + ] + }, + "CreateMetalGatewayElasticIp": { + "short_description": "Create a Metal Gateway Elastic IP", + "long_description": "Create a new Elastic IP on this Metal Gateway. Assign an IPv4 range as an elastic IP to the Metal Gateway, with a specified next-hop address contained within the Metal Gateway. Notice: Elastic IPs on Metal Gateways are a test feature currently under active development, and only available to certain users. Please contact Customer Success for more information.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Metal Gateway UUID" + } + ] + }, + "CreateMetalGatewayElasticIpExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateMetalGatewayExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteMetalGateway": { + "short_description": "Deletes the metal gateway", + "long_description": "Deletes a metal gateway and any elastic IP assignments associated with this metal gateway.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Metal Gateway UUID" + } + ] + }, + "DeleteMetalGatewayExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindMetalGatewayById": { + "short_description": "Returns the metal gateway", + "long_description": "Returns a specific metal gateway", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Metal Gateway UUID" + } + ] + }, + "FindMetalGatewayByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindMetalGatewaysByProject": { + "short_description": "Returns all metal gateways for a project", + "long_description": "Return all metal gateways for a project", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "projectId", + "description": "Project UUID" + } + ] + }, + "FindMetalGatewaysByProjectExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetBgpDynamicNeighbors": { + "short_description": "List BGP Dynamic Neighbors", + "long_description": "Returns the list of VRF BGP Dynamic Neighbors for this Metal Gateway", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Metal Gateway UUID" + } + ] + }, + "GetBgpDynamicNeighborsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetMetalGatewayElasticIps": { + "short_description": "List Metal Gateway Elastic IPs", + "long_description": "Returns the list of Elastic IPs assigned to this Metal Gateway", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Metal Gateway UUID" + } + ] + }, + "GetMetalGatewayElasticIpsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateBgpDynamicNeighborRequest": { + "type_name": "ApiCreateBgpDynamicNeighborRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bgpDynamicNeighborCreateInput": { + "name": "bgpDynamicNeighborCreateInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCreateMetalGatewayElasticIpRequest": { + "type_name": "ApiCreateMetalGatewayElasticIpRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "metalGatewayElasticIpCreateInput": { + "name": "metalGatewayElasticIpCreateInput", + "description": "" + } + } + }, + "ApiCreateMetalGatewayRequest": { + "type_name": "ApiCreateMetalGatewayRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createMetalGatewayRequest": { + "name": "createMetalGatewayRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiDeleteMetalGatewayRequest": { + "type_name": "ApiDeleteMetalGatewayRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindMetalGatewayByIdRequest": { + "type_name": "ApiFindMetalGatewayByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindMetalGatewaysByProjectRequest": { + "type_name": "ApiFindMetalGatewaysByProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiGetBgpDynamicNeighborsRequest": { + "type_name": "ApiGetBgpDynamicNeighborsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetMetalGatewayElasticIpsRequest": { + "type_name": "ApiGetMetalGatewayElasticIpsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + } + } + }, + "metros": { + "service_name": "metros", + "service_description": "", + "methods": { + "FindMetros": { + "short_description": "Retrieve all metros", + "long_description": "Provides a listing of available metros", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindMetrosExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetMetro": { + "short_description": "Retrieve a specific Metro's details", + "long_description": "Show the details for a metro, including name, code, and country.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Metro UUID" + } + ] + }, + "GetMetroExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiFindMetrosRequest": { + "type_name": "ApiFindMetrosRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetMetroRequest": { + "type_name": "ApiGetMetroRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + } + } + }, + "operating-systems": { + "service_name": "operating-systems", + "service_description": "", + "methods": { + "FindOperatingSystemVersion": { + "short_description": "Retrieve all operating system versions", + "long_description": "Provides a listing of available operating system versions.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindOperatingSystemVersionExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOperatingSystems": { + "short_description": "Retrieve all operating systems", + "long_description": "Provides a listing of available operating systems to provision your new device with.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindOperatingSystemsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiFindOperatingSystemVersionRequest": { + "type_name": "ApiFindOperatingSystemVersionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiFindOperatingSystemsRequest": { + "type_name": "ApiFindOperatingSystemsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + } + } + }, + "organizations": { + "service_name": "organizations", + "service_description": "", + "methods": { + "CreateOrganization": { + "short_description": "Create an organization", + "long_description": "Creates an organization.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateOrganizationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateOrganizationInvitation": { + "short_description": "Create an invitation for an organization", + "long_description": "In order to add a user to an organization, they must first be invited. To invite to several projects the parameter `projects_ids:[a,b,c]` can be used", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "CreateOrganizationInvitationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateOrganizationProject": { + "short_description": "Create a project for the organization", + "long_description": "Creates a new project for the organization", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "CreateOrganizationProjectExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreatePaymentMethod": { + "short_description": "Create a payment method for the given organization", + "long_description": "Creates a payment method.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "CreatePaymentMethodExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteOrganization": { + "short_description": "Delete the organization", + "long_description": "Deletes the organization.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "DeleteOrganizationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOperatingSystemsByOrganization": { + "short_description": "Retrieve all operating systems visible by the organization", + "long_description": "Returns a listing of available operating systems for the given organization", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOperatingSystemsByOrganizationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOrganizationById": { + "short_description": "Retrieve an organization's details", + "long_description": "Returns a single organization's details, if the user is authorized to view it.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOrganizationByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOrganizationCustomdata": { + "short_description": "Retrieve the custom metadata of an organization", + "long_description": "Provides the custom metadata stored for this organization in json format", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOrganizationCustomdataExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOrganizationInvitations": { + "short_description": "Retrieve organization invitations", + "long_description": "Returns all invitations in an organization.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOrganizationInvitationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOrganizationPaymentMethods": { + "short_description": "Retrieve all payment methods of an organization", + "long_description": "Returns all payment methods of an organization.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOrganizationPaymentMethodsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOrganizationProjects": { + "short_description": "Retrieve all projects of an organization", + "long_description": "Returns a collection of projects that belong to the organization.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOrganizationProjectsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOrganizationTransfers": { + "short_description": "Retrieve all project transfer requests from or to an organization", + "long_description": "Provides a collection of project transfer requests from or to the organization.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindOrganizationTransfersExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindOrganizations": { + "short_description": "Retrieve all organizations", + "long_description": "Returns a list of organizations that are accessible to the current user.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindOrganizationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindPlansByOrganization": { + "short_description": "Retrieve all plans visible by the organization", + "long_description": "Returns a listing of available plans for the given organization", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "FindPlansByOrganizationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateOrganization": { + "short_description": "Update the organization", + "long_description": "Updates the organization.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Organization UUID" + } + ] + }, + "UpdateOrganizationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateOrganizationInvitationRequest": { + "type_name": "ApiCreateOrganizationInvitationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "invitationInput": { + "name": "invitationInput", + "description": "" + } + } + }, + "ApiCreateOrganizationProjectRequest": { + "type_name": "ApiCreateOrganizationProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "projectCreateInput": { + "name": "projectCreateInput", + "description": "" + } + } + }, + "ApiCreateOrganizationRequest": { + "type_name": "ApiCreateOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "organizationInput": { + "name": "organizationInput", + "description": "" + } + } + }, + "ApiCreatePaymentMethodRequest": { + "type_name": "ApiCreatePaymentMethodRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "paymentMethodCreateInput": { + "name": "paymentMethodCreateInput", + "description": "" + } + } + }, + "ApiDeleteOrganizationRequest": { + "type_name": "ApiDeleteOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindOperatingSystemsByOrganizationRequest": { + "type_name": "ApiFindOperatingSystemsByOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindOrganizationByIdRequest": { + "type_name": "ApiFindOrganizationByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindOrganizationCustomdataRequest": { + "type_name": "ApiFindOrganizationCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindOrganizationInvitationsRequest": { + "type_name": "ApiFindOrganizationInvitationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindOrganizationPaymentMethodsRequest": { + "type_name": "ApiFindOrganizationPaymentMethodsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindOrganizationProjectsRequest": { + "type_name": "ApiFindOrganizationProjectsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "name": { + "name": "name", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindOrganizationTransfersRequest": { + "type_name": "ApiFindOrganizationTransfersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindOrganizationsRequest": { + "type_name": "ApiFindOrganizationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "personal": { + "name": "personal", + "description": "" + }, + "withoutProjects": { + "name": "withoutProjects", + "description": "" + } + } + }, + "ApiFindPlansByOrganizationRequest": { + "type_name": "ApiFindPlansByOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiUpdateOrganizationRequest": { + "type_name": "ApiUpdateOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "organizationInput": { + "name": "organizationInput", + "description": "" + } + } + } + } + }, + "password-reset-tokens": { + "service_name": "password-reset-tokens", + "service_description": "", + "methods": { + "CreatePasswordResetToken": { + "short_description": "Create a password reset token", + "long_description": "Creates a password reset token", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreatePasswordResetTokenExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ResetPassword": { + "short_description": "Reset current user password", + "long_description": "Resets current user password.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "ResetPasswordExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreatePasswordResetTokenRequest": { + "type_name": "ApiCreatePasswordResetTokenRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "email": { + "name": "email", + "description": "" + } + } + }, + "ApiResetPasswordRequest": { + "type_name": "ApiResetPasswordRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + } + } + }, + "payment-methods": { + "service_name": "payment-methods", + "service_description": "", + "methods": { + "DeletePaymentMethod": { + "short_description": "Delete the payment method", + "long_description": "Deletes the payment method.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Payment Method UUID" + } + ] + }, + "DeletePaymentMethodExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindPaymentMethodById": { + "short_description": "Retrieve a payment method", + "long_description": "Returns a payment method", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Payment Method UUID" + } + ] + }, + "FindPaymentMethodByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdatePaymentMethod": { + "short_description": "Update the payment method", + "long_description": "Updates the payment method.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Payment Method UUID" + } + ] + }, + "UpdatePaymentMethodExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiDeletePaymentMethodRequest": { + "type_name": "ApiDeletePaymentMethodRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindPaymentMethodByIdRequest": { + "type_name": "ApiFindPaymentMethodByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiUpdatePaymentMethodRequest": { + "type_name": "ApiUpdatePaymentMethodRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "paymentMethodUpdateInput": { + "name": "paymentMethodUpdateInput", + "description": "" + } + } + } + } + }, + "plans": { + "service_name": "plans", + "service_description": "", + "methods": { + "FindPlans": { + "short_description": "Retrieve all plans", + "long_description": "Provides a listing of available plans to provision your device on.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindPlansByProject": { + "short_description": "Retrieve all plans visible by the project", + "long_description": "Returns a listing of available plans for the given project", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindPlansByProjectExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindPlansExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiFindPlansByProjectRequest": { + "type_name": "ApiFindPlansByProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindPlansRequest": { + "type_name": "ApiFindPlansRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "categories": { + "name": "categories", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "slug": { + "name": "slug", + "description": "" + }, + "type_": { + "name": "type_", + "description": "" + } + } + } + } + }, + "ports": { + "service_name": "ports", + "service_description": "", + "methods": { + "AssignNativeVlan": { + "short_description": "Assign a native VLAN", + "long_description": "Sets a virtual network on this port as a \"native VLAN\". The VLAN must have already been assigned using the using the \"Assign a port to a virtual network\" operation.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "AssignNativeVlanExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "AssignPort": { + "short_description": "Assign a port to virtual network", + "long_description": "Assign a hardware port to a virtual network.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "AssignPortExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "BondPort": { + "short_description": "Enabling bonding", + "long_description": "Enabling bonding for one or all ports", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "BondPortExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ConvertLayer2": { + "short_description": "Convert to Layer 2", + "long_description": "Converts a bond port to Layer 2. IP assignments of the port will be removed.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "ConvertLayer2Execute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ConvertLayer3": { + "short_description": "Convert to Layer 3", + "long_description": "Converts a bond port to Layer 3. VLANs must first be unassigned.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "ConvertLayer3Execute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreatePortVlanAssignmentBatch": { + "short_description": "Create a new Port-VLAN Assignment management batch", + "long_description": "Create a new asynchronous batch request which handles adding and/or removing the VLANs to which the port is assigned.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "CreatePortVlanAssignmentBatchExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteNativeVlan": { + "short_description": "Remove native VLAN", + "long_description": "Removes the native VLAN from this port", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "DeleteNativeVlanExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DisbondPort": { + "short_description": "Disabling bonding", + "long_description": "Disabling bonding for one or all ports", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "DisbondPortExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindPortById": { + "short_description": "Retrieve a port", + "long_description": "Returns a port", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "FindPortByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindPortVlanAssignmentBatchByPortIdAndBatchId": { + "short_description": "Retrieve a VLAN Assignment Batch's details", + "long_description": "Returns the details of an existing Port-VLAN Assignment batch, including the list of VLANs to assign or unassign, and the current state of the batch.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + }, + { + "name": "batchId", + "description": "Batch ID" + } + ] + }, + "FindPortVlanAssignmentBatchByPortIdAndBatchIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindPortVlanAssignmentBatches": { + "short_description": "List the VLAN Assignment Batches for a port", + "long_description": "Show all the VLAN assignment batches that have been created for managing this port's VLAN assignments", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "FindPortVlanAssignmentBatchesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindPortVlanAssignmentByPortIdAndAssignmentId": { + "short_description": "Show a particular Port VLAN assignment's details", + "long_description": "Show the details of a specific Port-VLAN assignment, including the current state and if the VLAN is set as native.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + }, + { + "name": "assignmentId", + "description": "Assignment ID" + } + ] + }, + "FindPortVlanAssignmentByPortIdAndAssignmentIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindPortVlanAssignments": { + "short_description": "List Current VLAN assignments for a port", + "long_description": "Show the port's current VLAN assignments, including if this VLAN is set as native, and the current state of the assignment (ex. 'assigned' or 'unassigning')", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "FindPortVlanAssignmentsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UnassignPort": { + "short_description": "Unassign a port", + "long_description": "Unassign a port for a hardware.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Port UUID" + } + ] + }, + "UnassignPortExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiAssignNativeVlanRequest": { + "type_name": "ApiAssignNativeVlanRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vnid": { + "name": "vnid", + "description": "" + } + } + }, + "ApiAssignPortRequest": { + "type_name": "ApiAssignPortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portAssignInput": { + "name": "portAssignInput", + "description": "" + } + } + }, + "ApiBondPortRequest": { + "type_name": "ApiBondPortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bulkEnable": { + "name": "bulkEnable", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiConvertLayer2Request": { + "type_name": "ApiConvertLayer2Request", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portAssignInput": { + "name": "portAssignInput", + "description": "" + } + } + }, + "ApiConvertLayer3Request": { + "type_name": "ApiConvertLayer3Request", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portConvertLayer3Input": { + "name": "portConvertLayer3Input", + "description": "" + } + } + }, + "ApiCreatePortVlanAssignmentBatchRequest": { + "type_name": "ApiCreatePortVlanAssignmentBatchRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portVlanAssignmentBatchCreateInput": { + "name": "portVlanAssignmentBatchCreateInput", + "description": "" + } + } + }, + "ApiDeleteNativeVlanRequest": { + "type_name": "ApiDeleteNativeVlanRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDisbondPortRequest": { + "type_name": "ApiDisbondPortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bulkDisable": { + "name": "bulkDisable", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindPortByIdRequest": { + "type_name": "ApiFindPortByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindPortVlanAssignmentBatchByPortIdAndBatchIdRequest": { + "type_name": "ApiFindPortVlanAssignmentBatchByPortIdAndBatchIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "batchId": { + "name": "batchId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindPortVlanAssignmentBatchesRequest": { + "type_name": "ApiFindPortVlanAssignmentBatchesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindPortVlanAssignmentByPortIdAndAssignmentIdRequest": { + "type_name": "ApiFindPortVlanAssignmentByPortIdAndAssignmentIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "assignmentId": { + "name": "assignmentId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindPortVlanAssignmentsRequest": { + "type_name": "ApiFindPortVlanAssignmentsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiUnassignPortRequest": { + "type_name": "ApiUnassignPortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portAssignInput": { + "name": "portAssignInput", + "description": "" + } + } + } + } + }, + "projects": { + "service_name": "projects", + "service_description": "", + "methods": { + "CreateProject": { + "short_description": "Create a project", + "long_description": "Creates a new project for the user's default organization. If the user does not have a default organization, the API will look for a personal organization belonging to the user with the name \"{User's Full Name} Projects\" to associate the project with. If that organization does not exist a new organization named \"{User's Full Name} Projects\" will be created and the new project will be tied to that organization.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateProjectExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateProjectInvitation": { + "short_description": "Create an invitation for a project", + "long_description": "In order to add a user to a project, they must first be invited.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "projectId", + "description": "Project UUID" + } + ] + }, + "CreateProjectInvitationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateTransferRequest": { + "short_description": "Create a transfer request", + "long_description": "Organization owners can transfer their projects to other organizations. Deprecated", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "UUID of the project to be transferred" + } + ] + }, + "CreateTransferRequestExecute": { + "short_description": "Execute executes the request", + "long_description": "Deprecated" + }, + "DeleteProject": { + "short_description": "Delete the project", + "long_description": "Deletes the project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "DeleteProjectExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindIPReservationCustomdata": { + "short_description": "Retrieve the custom metadata of an IP Reservation", + "long_description": "Provides the custom metadata stored for this IP Reservation in json format", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "projectId", + "description": "Project UUID" + }, + { + "name": "id", + "description": "Ip Reservation UUID" + } + ] + }, + "FindIPReservationCustomdataExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectById": { + "short_description": "Retrieve a project", + "long_description": "Returns a single project if the user has access", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindProjectByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectCustomdata": { + "short_description": "Retrieve the custom metadata of a project", + "long_description": "Provides the custom metadata stored for this project in json format", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindProjectCustomdataExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectInvitations": { + "short_description": "Retrieve project invitations", + "long_description": "Returns all invitations in a project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "projectId", + "description": "Project UUID" + } + ] + }, + "FindProjectInvitationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectMemberships": { + "short_description": "Retrieve project memberships", + "long_description": "Returns all memberships in a project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "projectId", + "description": "Project UUID" + } + ] + }, + "FindProjectMembershipsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjects": { + "short_description": "Retrieve all projects", + "long_description": "Returns a collection of projects that the current user is a member of.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindProjectsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateProject": { + "short_description": "Update the project", + "long_description": "Updates the project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "UpdateProjectExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateProjectInvitationRequest": { + "type_name": "ApiCreateProjectInvitationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "invitationInput": { + "name": "invitationInput", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiCreateProjectRequest": { + "type_name": "ApiCreateProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "projectCreateFromRootInput": { + "name": "projectCreateFromRootInput", + "description": "" + } + } + }, + "ApiCreateTransferRequestRequest": { + "type_name": "ApiCreateTransferRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "transferRequestInput": { + "name": "transferRequestInput", + "description": "" + } + } + }, + "ApiDeleteProjectRequest": { + "type_name": "ApiDeleteProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindIPReservationCustomdataRequest": { + "type_name": "ApiFindIPReservationCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiFindProjectByIdRequest": { + "type_name": "ApiFindProjectByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindProjectCustomdataRequest": { + "type_name": "ApiFindProjectCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindProjectInvitationsRequest": { + "type_name": "ApiFindProjectInvitationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiFindProjectMembershipsRequest": { + "type_name": "ApiFindProjectMembershipsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + }, + "search": { + "name": "search", + "description": "" + } + } + }, + "ApiFindProjectsRequest": { + "type_name": "ApiFindProjectsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "name": { + "name": "name", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiUpdateProjectRequest": { + "type_name": "ApiUpdateProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "projectUpdateInput": { + "name": "projectUpdateInput", + "description": "" + } + } + } + } + }, + "self-service-reservations": { + "service_name": "self-service-reservations", + "service_description": "", + "methods": { + "CreateSelfServiceReservation": { + "short_description": "Create a reservation", + "long_description": "Creates a reservation.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "projectId", + "description": "Project UUID" + } + ] + }, + "CreateSelfServiceReservationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindSelfServiceReservation": { + "short_description": "Retrieve a reservation", + "long_description": "Returns a reservation", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Reservation short_id" + }, + { + "name": "projectId", + "description": "Project UUID" + } + ] + }, + "FindSelfServiceReservationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindSelfServiceReservations": { + "short_description": "Retrieve all reservations", + "long_description": "Returns all reservations.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "projectId", + "description": "Project UUID" + } + ] + }, + "FindSelfServiceReservationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateSelfServiceReservationRequest": { + "type_name": "ApiCreateSelfServiceReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createSelfServiceReservationRequest": { + "name": "createSelfServiceReservationRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiFindSelfServiceReservationRequest": { + "type_name": "ApiFindSelfServiceReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiFindSelfServiceReservationsRequest": { + "type_name": "ApiFindSelfServiceReservationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "categories": { + "name": "categories", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + } + } + }, + "spot-market": { + "service_name": "spot-market", + "service_description": "", + "methods": { + "CreateSpotMarketRequest": { + "short_description": "Create a spot market request", + "long_description": "Creates a new spot market request. Type-specific options (such as operating_system for baremetal devices) should be included in the main data structure alongside hostname and plan. The features attribute allows you to optionally specify what features your server should have. For example, if you require a server with a TPM chip, you may specify `{ \"features\": { \"tpm\": \"required\" } }` (or `{ \"features\": [\"tpm\"] }` in shorthand). The request will fail if there are no available servers matching your criteria. Alternatively, if you do not require a certain feature, but would prefer to be assigned a server with that feature if there are any available, you may specify that feature with a preferred value (see the example request below). The request will not fail if we have no servers with that feature in our inventory.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "CreateSpotMarketRequestExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteSpotMarketRequest": { + "short_description": "Delete the spot market request", + "long_description": "Deletes the spot market request.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "SpotMarketRequest UUID" + } + ] + }, + "DeleteSpotMarketRequestExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindMetroSpotMarketPrices": { + "short_description": "Get current spot market prices for metros", + "long_description": "Get Equinix Metal current spot market prices for all metros.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindMetroSpotMarketPricesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindSpotMarketPrices": { + "short_description": "Get current spot market prices", + "long_description": "Get Equinix Metal current spot market prices.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindSpotMarketPricesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindSpotMarketPricesHistory": { + "short_description": "Get spot market prices for a given period of time", + "long_description": "# Get spot market prices for a given plan and facility in a fixed period of time *Note: In the `200` response, the property `datapoints` contains arrays of `[float, integer]`.*", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindSpotMarketPricesHistoryExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindSpotMarketRequestById": { + "short_description": "Retrieve a spot market request", + "long_description": "Returns a single spot market request", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "SpotMarketRequest UUID" + } + ] + }, + "FindSpotMarketRequestByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ListSpotMarketRequests": { + "short_description": "List spot market requests", + "long_description": "View all spot market requests for a given project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "ListSpotMarketRequestsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateSpotMarketRequestRequest": { + "type_name": "ApiCreateSpotMarketRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "spotMarketRequestCreateInput": { + "name": "spotMarketRequestCreateInput", + "description": "" + } + } + }, + "ApiDeleteSpotMarketRequestRequest": { + "type_name": "ApiDeleteSpotMarketRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "forceTermination": { + "name": "forceTermination", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindMetroSpotMarketPricesRequest": { + "type_name": "ApiFindMetroSpotMarketPricesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "metro": { + "name": "metro", + "description": "" + }, + "plan": { + "name": "plan", + "description": "" + } + } + }, + "ApiFindSpotMarketPricesHistoryRequest": { + "type_name": "ApiFindSpotMarketPricesHistoryRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "facility": { + "name": "facility", + "description": "" + }, + "from": { + "name": "from", + "description": "" + }, + "metro": { + "name": "metro", + "description": "" + }, + "plan": { + "name": "plan", + "description": "" + }, + "until": { + "name": "until", + "description": "" + } + } + }, + "ApiFindSpotMarketPricesRequest": { + "type_name": "ApiFindSpotMarketPricesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "facility": { + "name": "facility", + "description": "" + }, + "plan": { + "name": "plan", + "description": "" + } + } + }, + "ApiFindSpotMarketRequestByIdRequest": { + "type_name": "ApiFindSpotMarketRequestByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiListSpotMarketRequestsRequest": { + "type_name": "ApiListSpotMarketRequestsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + } + } + }, + "ssh-keys": { + "service_name": "ssh-keys", + "service_description": "", + "methods": { + "CreateProjectSSHKey": { + "short_description": "Create a ssh key for the given project", + "long_description": "Creates a ssh key.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "CreateProjectSSHKeyExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateSSHKey": { + "short_description": "Create a ssh key for the current user", + "long_description": "Creates a ssh key.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateSSHKeyExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteSSHKey": { + "short_description": "Delete the ssh key", + "long_description": "Deletes the ssh key.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "ssh key UUID" + } + ] + }, + "DeleteSSHKeyExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindDeviceSSHKeys": { + "short_description": "Retrieve a device's ssh keys", + "long_description": "Returns a collection of the device's ssh keys.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindDeviceSSHKeysExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectSSHKeys": { + "short_description": "Retrieve a project's ssh keys", + "long_description": "Returns a collection of the project's ssh keys.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindProjectSSHKeysExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindSSHKeyById": { + "short_description": "Retrieve a ssh key", + "long_description": "Returns a single ssh key if the user has access", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "SSH Key UUID" + } + ] + }, + "FindSSHKeyByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindSSHKeys": { + "short_description": "Retrieve all ssh keys", + "long_description": "Returns a collection of the user’s ssh keys.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindSSHKeysExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateSSHKey": { + "short_description": "Update the ssh key", + "long_description": "Updates the ssh key.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "SSH Key UUID" + } + ] + }, + "UpdateSSHKeyExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateProjectSSHKeyRequest": { + "type_name": "ApiCreateProjectSSHKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "sSHKeyCreateInput": { + "name": "sSHKeyCreateInput", + "description": "" + } + } + }, + "ApiCreateSSHKeyRequest": { + "type_name": "ApiCreateSSHKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "sSHKeyCreateInput": { + "name": "sSHKeyCreateInput", + "description": "" + } + } + }, + "ApiDeleteSSHKeyRequest": { + "type_name": "ApiDeleteSSHKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindDeviceSSHKeysRequest": { + "type_name": "ApiFindDeviceSSHKeysRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "searchString": { + "name": "searchString", + "description": "" + } + } + }, + "ApiFindProjectSSHKeysRequest": { + "type_name": "ApiFindProjectSSHKeysRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "query": { + "name": "query", + "description": "" + } + } + }, + "ApiFindSSHKeyByIdRequest": { + "type_name": "ApiFindSSHKeyByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindSSHKeysRequest": { + "type_name": "ApiFindSSHKeysRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "search": { + "name": "search", + "description": "" + } + } + }, + "ApiUpdateSSHKeyRequest": { + "type_name": "ApiUpdateSSHKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "sSHKeyInput": { + "name": "sSHKeyInput", + "description": "" + } + } + } + } + }, + "support-request": { + "service_name": "support-request", + "service_description": "", + "methods": { + "RequestSupport": { + "short_description": "Create a support ticket", + "long_description": "Support Ticket.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "RequestSupportExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiRequestSupportRequest": { + "type_name": "ApiRequestSupportRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "supportRequestInput": { + "name": "supportRequestInput", + "description": "" + } + } + } + } + }, + "transfer-requests": { + "service_name": "transfer-requests", + "service_description": "", + "methods": { + "AcceptTransferRequest": { + "short_description": "Accept a transfer request", + "long_description": "Accept a transfer request.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Transfer request UUID" + } + ] + }, + "AcceptTransferRequestExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeclineTransferRequest": { + "short_description": "Decline a transfer request", + "long_description": "Decline a transfer request.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Transfer request UUID" + } + ] + }, + "DeclineTransferRequestExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindTransferRequestById": { + "short_description": "View a transfer request", + "long_description": "Returns a single transfer request.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Transfer request UUID" + } + ] + }, + "FindTransferRequestByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiAcceptTransferRequestRequest": { + "type_name": "ApiAcceptTransferRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeclineTransferRequestRequest": { + "type_name": "ApiDeclineTransferRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindTransferRequestByIdRequest": { + "type_name": "ApiFindTransferRequestByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + } + } + }, + "two-factor-auth": { + "service_name": "two-factor-auth", + "service_description": "", + "methods": { + "DisableTfaApp": { + "short_description": "Disable two factor authentication", + "long_description": "Disables two factor authentication.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "DisableTfaAppExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "EnableTfaApp": { + "short_description": "Enable two factor auth using app", + "long_description": "Enables two factor authentication using authenticator app.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "EnableTfaAppExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiDisableTfaAppRequest": { + "type_name": "ApiDisableTfaAppRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "xOtpToken": { + "name": "xOtpToken", + "description": "" + } + } + }, + "ApiEnableTfaAppRequest": { + "type_name": "ApiEnableTfaAppRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "xOtpToken": { + "name": "xOtpToken", + "description": "" + } + } + } + } + }, + "usages": { + "service_name": "usages", + "service_description": "", + "methods": { + "FindDeviceUsages": { + "short_description": "Retrieve all usages for device", + "long_description": "Returns all usages for a device.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Device UUID" + } + ] + }, + "FindDeviceUsagesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindProjectUsage": { + "short_description": "Retrieve all usages for project", + "long_description": "Returns all usages for a project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindProjectUsageExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiFindDeviceUsagesRequest": { + "type_name": "ApiFindDeviceUsagesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createdAfter": { + "name": "createdAfter", + "description": "" + }, + "createdBefore": { + "name": "createdBefore", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindProjectUsageRequest": { + "type_name": "ApiFindProjectUsageRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createdAfter": { + "name": "createdAfter", + "description": "" + }, + "createdBefore": { + "name": "createdBefore", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + } + } + }, + "user-verification-tokens": { + "service_name": "user-verification-tokens", + "service_description": "", + "methods": { + "ConsumeVerificationRequest": { + "short_description": "Verify a user using an email verification token", + "long_description": "Consumes an email verification token and verifies the user associated with it.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "ConsumeVerificationRequestExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateValidationRequest": { + "short_description": "Create an email verification request", + "long_description": "Creates an email verification request", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateValidationRequestExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiConsumeVerificationRequestRequest": { + "type_name": "ApiConsumeVerificationRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "verifyEmail": { + "name": "verifyEmail", + "description": "" + } + } + }, + "ApiCreateValidationRequestRequest": { + "type_name": "ApiCreateValidationRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "login": { + "name": "login", + "description": "" + } + } + } + } + }, + "userdata": { + "service_name": "userdata", + "service_description": "", + "methods": { + "ValidateUserdata": { + "short_description": "Validate user data", + "long_description": "Validates user data (Userdata)", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "ValidateUserdataExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiValidateUserdataRequest": { + "type_name": "ApiValidateUserdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "userdata": { + "name": "userdata", + "description": "" + } + } + } + } + }, + "users": { + "service_name": "users", + "service_description": "", + "methods": { + "CreateUser": { + "short_description": "Create a user", + "long_description": "Creates a user.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateUserExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindCurrentUser": { + "short_description": "Retrieve the current user", + "long_description": "Returns the user object for the currently logged-in user.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindCurrentUserExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindInvitations": { + "short_description": "Retrieve current user invitations", + "long_description": "Returns all invitations in current user.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindInvitationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindUserById": { + "short_description": "Retrieve a user", + "long_description": "Returns a single user if the user has access", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "User UUID" + } + ] + }, + "FindUserByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindUserCustomdata": { + "short_description": "Retrieve the custom metadata of a user", + "long_description": "Provides the custom metadata stored for this user in json format", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "User UUID" + } + ] + }, + "FindUserCustomdataExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindUsers": { + "short_description": "Retrieve all users", + "long_description": "Returns a list of users that the are accessible to the current user (all users in the current user’s projects, essentially).", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "FindUsersExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateCurrentUser": { + "short_description": "Update the current user", + "long_description": "Updates the currently logged-in user.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "UpdateCurrentUserExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateUserRequest": { + "type_name": "ApiCreateUserRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "userCreateInput": { + "name": "userCreateInput", + "description": "" + } + } + }, + "ApiFindCurrentUserRequest": { + "type_name": "ApiFindCurrentUserRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindInvitationsRequest": { + "type_name": "ApiFindInvitationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindUserByIdRequest": { + "type_name": "ApiFindUserByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindUserCustomdataRequest": { + "type_name": "ApiFindUserCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindUsersRequest": { + "type_name": "ApiFindUsersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiUpdateCurrentUserRequest": { + "type_name": "ApiUpdateCurrentUserRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "userUpdateInput": { + "name": "userUpdateInput", + "description": "" + } + } + } + } + }, + "vlans": { + "service_name": "vlans", + "service_description": "", + "methods": { + "CreateVirtualNetwork": { + "short_description": "Create a virtual network", + "long_description": "Creates an virtual network.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "CreateVirtualNetworkExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteVirtualNetwork": { + "short_description": "Delete a virtual network", + "long_description": "Deletes a virtual network.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Virtual Network UUID" + } + ] + }, + "DeleteVirtualNetworkExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindVirtualNetworks": { + "short_description": "Retrieve all virtual networks", + "long_description": "Provides a list of virtual networks for a single project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindVirtualNetworksExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetVirtualNetwork": { + "short_description": "Get a virtual network", + "long_description": "Get a virtual network.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Virtual Network UUID" + } + ] + }, + "GetVirtualNetworkExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateVirtualNetwork": { + "short_description": "Updates the virtual network", + "long_description": "Updates the virtual network.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Virtual Network UUID" + } + ] + }, + "UpdateVirtualNetworkExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateVirtualNetworkRequest": { + "type_name": "ApiCreateVirtualNetworkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "virtualNetworkCreateInput": { + "name": "virtualNetworkCreateInput", + "description": "" + } + } + }, + "ApiDeleteVirtualNetworkRequest": { + "type_name": "ApiDeleteVirtualNetworkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindVirtualNetworksRequest": { + "type_name": "ApiFindVirtualNetworksRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "facility": { + "name": "facility", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "metro": { + "name": "metro", + "description": "" + } + } + }, + "ApiGetVirtualNetworkRequest": { + "type_name": "ApiGetVirtualNetworkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiUpdateVirtualNetworkRequest": { + "type_name": "ApiUpdateVirtualNetworkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "virtualNetworkUpdateInput": { + "name": "virtualNetworkUpdateInput", + "description": "" + } + } + } + } + }, + "vrfs": { + "service_name": "vrfs", + "service_description": "", + "methods": { + "BgpDynamicNeighborsIdGet": { + "short_description": "Retrieve a BGP Dynamic Neighbor", + "long_description": "Return a single BGP Dynamic Neighbor resource", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "BGP Dynamic Neighbor UUID" + } + ] + }, + "BgpDynamicNeighborsIdGetExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateVrf": { + "short_description": "Create a new VRF in the specified project", + "long_description": "Creates a new VRF in the specified project", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "CreateVrfExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CreateVrfRoute": { + "short_description": "Create a VRF route", + "long_description": "Create a route in a VRF. Currently only static default routes are supported.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF UUID" + } + ] + }, + "CreateVrfRouteExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteBgpDynamicNeighborById": { + "short_description": "Delete a VRF BGP Dynamic Neighbor", + "long_description": "Trigger the removal of a BGP Neighbor range from a VRF", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "BGP Dynamic Neighbor UUID" + } + ] + }, + "DeleteBgpDynamicNeighborByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteVrf": { + "short_description": "Delete the VRF", + "long_description": "Deletes the VRF", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF UUID" + } + ] + }, + "DeleteVrfExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "DeleteVrfRouteById": { + "short_description": "Delete a VRF Route", + "long_description": "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.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF Route UUID" + } + ] + }, + "DeleteVrfRouteByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindVrfById": { + "short_description": "Retrieve a VRF", + "long_description": "Returns a single VRF resource", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF UUID" + } + ] + }, + "FindVrfByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindVrfIpReservation": { + "short_description": "Retrieve the Specified VRF IP Reservation", + "long_description": "Returns the specified IP Reservation for the VRF.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "vrfId", + "description": "VRF UUID" + }, + { + "name": "id", + "description": "IP UUID" + } + ] + }, + "FindVrfIpReservationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindVrfIpReservations": { + "short_description": "Retrieve all VRF IP Reservations in the VRF", + "long_description": "Returns the list of VRF IP Reservations for the VRF.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF UUID" + } + ] + }, + "FindVrfIpReservationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindVrfRouteById": { + "short_description": "Retrieve a VRF Route", + "long_description": "Returns a single VRF Route resource", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF Route UUID" + } + ] + }, + "FindVrfRouteByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "FindVrfs": { + "short_description": "Retrieve all VRFs in the project", + "long_description": "Returns the list of VRFs for a single project.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "Project UUID" + } + ] + }, + "FindVrfsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetVrfBGPNeighbors": { + "short_description": "Retrieve BGP neighbor states for the VRF", + "long_description": "Provides BGP peering information such as the IP and state of the neighbor.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF UUID" + } + ] + }, + "GetVrfBGPNeighborsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetVrfLearnedRoutes": { + "short_description": "Retrieve learned L3 routes within the VRF", + "long_description": "Provides information about learned routes for the VRF. The VRF builds this information dynamically though BGP from other routers in the network.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF UUID" + } + ] + }, + "GetVrfLearnedRoutesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GetVrfRoutes": { + "short_description": "Retrieve all routes in the VRF", + "long_description": "Returns the list of routes for the VRF", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF UUID" + } + ] + }, + "GetVrfRoutesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateVrf": { + "short_description": "Update the VRF", + "long_description": "Updates the VRF.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF UUID" + } + ] + }, + "UpdateVrfExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "UpdateVrfRouteById": { + "short_description": "Update a VRF Route", + "long_description": "Requests a VRF Route be redeployed across the network. Updating the prefix or next-hop address on a route is not currently supported.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "id", + "description": "VRF Route UUID" + } + ] + }, + "UpdateVrfRouteByIdExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiBgpDynamicNeighborsIdGetRequest": { + "type_name": "ApiBgpDynamicNeighborsIdGetRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCreateVrfRequest": { + "type_name": "ApiCreateVrfRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vrfCreateInput": { + "name": "vrfCreateInput", + "description": "" + } + } + }, + "ApiCreateVrfRouteRequest": { + "type_name": "ApiCreateVrfRouteRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vrfRouteCreateInput": { + "name": "vrfRouteCreateInput", + "description": "" + } + } + }, + "ApiDeleteBgpDynamicNeighborByIdRequest": { + "type_name": "ApiDeleteBgpDynamicNeighborByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDeleteVrfRequest": { + "type_name": "ApiDeleteVrfRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteVrfRouteByIdRequest": { + "type_name": "ApiDeleteVrfRouteByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindVrfByIdRequest": { + "type_name": "ApiFindVrfByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindVrfIpReservationRequest": { + "type_name": "ApiFindVrfIpReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vrfId": { + "name": "vrfId", + "description": "" + } + } + }, + "ApiFindVrfIpReservationsRequest": { + "type_name": "ApiFindVrfIpReservationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindVrfRouteByIdRequest": { + "type_name": "ApiFindVrfRouteByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindVrfsRequest": { + "type_name": "ApiFindVrfsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "metro": { + "name": "metro", + "description": "" + } + } + }, + "ApiGetVrfBGPNeighborsRequest": { + "type_name": "ApiGetVrfBGPNeighborsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiGetVrfLearnedRoutesRequest": { + "type_name": "ApiGetVrfLearnedRoutesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiGetVrfRoutesRequest": { + "type_name": "ApiGetVrfRoutesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiUpdateVrfRequest": { + "type_name": "ApiUpdateVrfRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vrfUpdateInput": { + "name": "vrfUpdateInput", + "description": "" + } + } + }, + "ApiUpdateVrfRouteByIdRequest": { + "type_name": "ApiUpdateVrfRouteByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vrfRouteUpdateInput": { + "name": "vrfRouteUpdateInput", + "description": "" + } + } + } + } + } + }, + "types": { + "APIClient": { + "type_name": "APIClient", + "description": "APIClient manages communication with the Metal API API v1.0.0\nIn most cases there should be only one, shared, APIClient.", + "fields": { + "AuthenticationApi": { + "name": "AuthenticationApi", + "description": "" + }, + "BGPApi": { + "name": "BGPApi", + "description": "" + }, + "BatchesApi": { + "name": "BatchesApi", + "description": "" + }, + "CapacityApi": { + "name": "CapacityApi", + "description": "" + }, + "ConsoleLogDetailsApi": { + "name": "ConsoleLogDetailsApi", + "description": "" + }, + "DevicesApi": { + "name": "DevicesApi", + "description": "" + }, + "EmailsApi": { + "name": "EmailsApi", + "description": "" + }, + "EventsApi": { + "name": "EventsApi", + "description": "" + }, + "FacilitiesApi": { + "name": "FacilitiesApi", + "description": "" + }, + "FirmwareSetsApi": { + "name": "FirmwareSetsApi", + "description": "" + }, + "HardwareReservationsApi": { + "name": "HardwareReservationsApi", + "description": "" + }, + "IPAddressesApi": { + "name": "IPAddressesApi", + "description": "" + }, + "IncidentsApi": { + "name": "IncidentsApi", + "description": "" + }, + "InterconnectionsApi": { + "name": "InterconnectionsApi", + "description": "" + }, + "InvitationsApi": { + "name": "InvitationsApi", + "description": "" + }, + "InvoicesApi": { + "name": "InvoicesApi", + "description": "" + }, + "LicensesApi": { + "name": "LicensesApi", + "description": "" + }, + "MembershipsApi": { + "name": "MembershipsApi", + "description": "" + }, + "MetalGatewaysApi": { + "name": "MetalGatewaysApi", + "description": "" + }, + "MetrosApi": { + "name": "MetrosApi", + "description": "" + }, + "OperatingSystemsApi": { + "name": "OperatingSystemsApi", + "description": "" + }, + "OrganizationsApi": { + "name": "OrganizationsApi", + "description": "" + }, + "PasswordResetTokensApi": { + "name": "PasswordResetTokensApi", + "description": "" + }, + "PaymentMethodsApi": { + "name": "PaymentMethodsApi", + "description": "" + }, + "PlansApi": { + "name": "PlansApi", + "description": "" + }, + "PortsApi": { + "name": "PortsApi", + "description": "" + }, + "ProjectsApi": { + "name": "ProjectsApi", + "description": "" + }, + "SSHKeysApi": { + "name": "SSHKeysApi", + "description": "" + }, + "SelfServiceReservationsApi": { + "name": "SelfServiceReservationsApi", + "description": "" + }, + "SpotMarketApi": { + "name": "SpotMarketApi", + "description": "" + }, + "SupportRequestApi": { + "name": "SupportRequestApi", + "description": "" + }, + "TransferRequestsApi": { + "name": "TransferRequestsApi", + "description": "" + }, + "TwoFactorAuthApi": { + "name": "TwoFactorAuthApi", + "description": "" + }, + "UsagesApi": { + "name": "UsagesApi", + "description": "" + }, + "UserVerificationTokensApi": { + "name": "UserVerificationTokensApi", + "description": "" + }, + "UserdataApi": { + "name": "UserdataApi", + "description": "" + }, + "UsersApi": { + "name": "UsersApi", + "description": "" + }, + "VLANsApi": { + "name": "VLANsApi", + "description": "" + }, + "VRFsApi": { + "name": "VRFsApi", + "description": "" + }, + "cfg": { + "name": "cfg", + "description": "" + }, + "common": { + "name": "common", + "description": "Reuse a single struct instead of allocating one for each service on the heap." + } + } + }, + "APIKey": { + "type_name": "APIKey", + "description": "APIKey provides API key based authentication to a request passed via context using ContextAPIKey", + "fields": { + "Key": { + "name": "Key", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "" + } + } + }, + "APIResponse": { + "type_name": "APIResponse", + "description": "APIResponse stores the API response returned by the server.", + "fields": { + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "Method": { + "name": "Method", + "description": "Method is the HTTP method used for the request. This value is always\navailable, even if the embedded *http.Response is nil.", + "json_tag": "method" + }, + "Operation": { + "name": "Operation", + "description": "Operation is the name of the OpenAPI operation.", + "json_tag": "operation" + }, + "Payload": { + "name": "Payload", + "description": "Payload holds the contents of the response body (which may be nil or empty).\nThis is provided here as the raw response.Body() reader will have already\nbeen drained.", + "json_tag": "-" + }, + "RequestURL": { + "name": "RequestURL", + "description": "RequestURL is the request URL. This value is always available, even if the\nembedded *http.Response is nil.", + "json_tag": "url" + } + } + }, + "AWSFabricProvider": { + "type_name": "AWSFabricProvider", + "description": "AWSFabricProvider struct for AWSFabricProvider", + "fields": { + "AccountId": { + "name": "AccountId", + "description": "AWS Account ID", + "json_tag": "account_id\" validate:\"regexp=^\\\\\\\\d{12}$" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ActivateHardwareReservationRequest": { + "type_name": "ActivateHardwareReservationRequest", + "description": "ActivateHardwareReservationRequest struct for ActivateHardwareReservationRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + } + } + }, + "Address": { + "type_name": "Address", + "description": "Address struct for Address", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + }, + "Address2": { + "name": "Address2", + "description": "", + "json_tag": "address2" + }, + "City": { + "name": "City", + "description": "", + "json_tag": "city" + }, + "Coordinates": { + "name": "Coordinates", + "description": "", + "json_tag": "coordinates" + }, + "Country": { + "name": "Country", + "description": "", + "json_tag": "country" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "ZipCode": { + "name": "ZipCode", + "description": "", + "json_tag": "zip_code" + } + } + }, + "ApiAcceptInvitationRequest": { + "type_name": "ApiAcceptInvitationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiAcceptTransferRequestRequest": { + "type_name": "ApiAcceptTransferRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiActivateHardwareReservationRequest": { + "type_name": "ApiActivateHardwareReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "activateHardwareReservationRequest": { + "name": "activateHardwareReservationRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiAssignNativeVlanRequest": { + "type_name": "ApiAssignNativeVlanRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vnid": { + "name": "vnid", + "description": "" + } + } + }, + "ApiAssignPortRequest": { + "type_name": "ApiAssignPortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portAssignInput": { + "name": "portAssignInput", + "description": "" + } + } + }, + "ApiBgpDynamicNeighborsIdGetRequest": { + "type_name": "ApiBgpDynamicNeighborsIdGetRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiBondPortRequest": { + "type_name": "ApiBondPortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bulkEnable": { + "name": "bulkEnable", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCaptureScreenshotRequest": { + "type_name": "ApiCaptureScreenshotRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiCheckCapacityForFacilityRequest": { + "type_name": "ApiCheckCapacityForFacilityRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "capacityInput": { + "name": "capacityInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiCheckCapacityForMetroRequest": { + "type_name": "ApiCheckCapacityForMetroRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "capacityInput": { + "name": "capacityInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiConsumeVerificationRequestRequest": { + "type_name": "ApiConsumeVerificationRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "verifyEmail": { + "name": "verifyEmail", + "description": "" + } + } + }, + "ApiConvertLayer2Request": { + "type_name": "ApiConvertLayer2Request", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portAssignInput": { + "name": "portAssignInput", + "description": "" + } + } + }, + "ApiConvertLayer3Request": { + "type_name": "ApiConvertLayer3Request", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portConvertLayer3Input": { + "name": "portConvertLayer3Input", + "description": "" + } + } + }, + "ApiCreateAPIKeyRequest": { + "type_name": "ApiCreateAPIKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authTokenInput": { + "name": "authTokenInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCreateBgpDynamicNeighborRequest": { + "type_name": "ApiCreateBgpDynamicNeighborRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bgpDynamicNeighborCreateInput": { + "name": "bgpDynamicNeighborCreateInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCreateBgpSessionRequest": { + "type_name": "ApiCreateBgpSessionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bGPSessionInput": { + "name": "bGPSessionInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCreateDeviceBatchRequest": { + "type_name": "ApiCreateDeviceBatchRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "instancesBatchCreateInput": { + "name": "instancesBatchCreateInput", + "description": "" + } + } + }, + "ApiCreateDeviceRequest": { + "type_name": "ApiCreateDeviceRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createDeviceRequest": { + "name": "createDeviceRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCreateEmailRequest": { + "type_name": "ApiCreateEmailRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createEmailInput": { + "name": "createEmailInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiCreateIPAssignmentRequest": { + "type_name": "ApiCreateIPAssignmentRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "iPAssignmentInput": { + "name": "iPAssignmentInput", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCreateInterconnectionPortVirtualCircuitRequest": { + "type_name": "ApiCreateInterconnectionPortVirtualCircuitRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + }, + "virtualCircuitCreateInput": { + "name": "virtualCircuitCreateInput", + "description": "" + } + } + }, + "ApiCreateLicenseRequest": { + "type_name": "ApiCreateLicenseRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "licenseCreateInput": { + "name": "licenseCreateInput", + "description": "" + } + } + }, + "ApiCreateMetalGatewayElasticIpRequest": { + "type_name": "ApiCreateMetalGatewayElasticIpRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "metalGatewayElasticIpCreateInput": { + "name": "metalGatewayElasticIpCreateInput", + "description": "" + } + } + }, + "ApiCreateMetalGatewayRequest": { + "type_name": "ApiCreateMetalGatewayRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createMetalGatewayRequest": { + "name": "createMetalGatewayRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiCreateOrganizationInterconnectionRequest": { + "type_name": "ApiCreateOrganizationInterconnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createOrganizationInterconnectionRequest": { + "name": "createOrganizationInterconnectionRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "organizationId": { + "name": "organizationId", + "description": "" + } + } + }, + "ApiCreateOrganizationInvitationRequest": { + "type_name": "ApiCreateOrganizationInvitationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "invitationInput": { + "name": "invitationInput", + "description": "" + } + } + }, + "ApiCreateOrganizationProjectRequest": { + "type_name": "ApiCreateOrganizationProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "projectCreateInput": { + "name": "projectCreateInput", + "description": "" + } + } + }, + "ApiCreateOrganizationRequest": { + "type_name": "ApiCreateOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "organizationInput": { + "name": "organizationInput", + "description": "" + } + } + }, + "ApiCreatePasswordResetTokenRequest": { + "type_name": "ApiCreatePasswordResetTokenRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "email": { + "name": "email", + "description": "" + } + } + }, + "ApiCreatePaymentMethodRequest": { + "type_name": "ApiCreatePaymentMethodRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "paymentMethodCreateInput": { + "name": "paymentMethodCreateInput", + "description": "" + } + } + }, + "ApiCreatePortVlanAssignmentBatchRequest": { + "type_name": "ApiCreatePortVlanAssignmentBatchRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portVlanAssignmentBatchCreateInput": { + "name": "portVlanAssignmentBatchCreateInput", + "description": "" + } + } + }, + "ApiCreateProjectAPIKeyRequest": { + "type_name": "ApiCreateProjectAPIKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authTokenInput": { + "name": "authTokenInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiCreateProjectInterconnectionRequest": { + "type_name": "ApiCreateProjectInterconnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createOrganizationInterconnectionRequest": { + "name": "createOrganizationInterconnectionRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiCreateProjectInvitationRequest": { + "type_name": "ApiCreateProjectInvitationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "invitationInput": { + "name": "invitationInput", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiCreateProjectRequest": { + "type_name": "ApiCreateProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "projectCreateFromRootInput": { + "name": "projectCreateFromRootInput", + "description": "" + } + } + }, + "ApiCreateProjectSSHKeyRequest": { + "type_name": "ApiCreateProjectSSHKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "sSHKeyCreateInput": { + "name": "sSHKeyCreateInput", + "description": "" + } + } + }, + "ApiCreateSSHKeyRequest": { + "type_name": "ApiCreateSSHKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "sSHKeyCreateInput": { + "name": "sSHKeyCreateInput", + "description": "" + } + } + }, + "ApiCreateSelfServiceReservationRequest": { + "type_name": "ApiCreateSelfServiceReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createSelfServiceReservationRequest": { + "name": "createSelfServiceReservationRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiCreateSpotMarketRequestRequest": { + "type_name": "ApiCreateSpotMarketRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "spotMarketRequestCreateInput": { + "name": "spotMarketRequestCreateInput", + "description": "" + } + } + }, + "ApiCreateTransferRequestRequest": { + "type_name": "ApiCreateTransferRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "transferRequestInput": { + "name": "transferRequestInput", + "description": "" + } + } + }, + "ApiCreateUserRequest": { + "type_name": "ApiCreateUserRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "userCreateInput": { + "name": "userCreateInput", + "description": "" + } + } + }, + "ApiCreateValidationRequestRequest": { + "type_name": "ApiCreateValidationRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "login": { + "name": "login", + "description": "" + } + } + }, + "ApiCreateVirtualNetworkRequest": { + "type_name": "ApiCreateVirtualNetworkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "virtualNetworkCreateInput": { + "name": "virtualNetworkCreateInput", + "description": "" + } + } + }, + "ApiCreateVrfRequest": { + "type_name": "ApiCreateVrfRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vrfCreateInput": { + "name": "vrfCreateInput", + "description": "" + } + } + }, + "ApiCreateVrfRouteRequest": { + "type_name": "ApiCreateVrfRouteRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vrfRouteCreateInput": { + "name": "vrfRouteCreateInput", + "description": "" + } + } + }, + "ApiDeclineInvitationRequest": { + "type_name": "ApiDeclineInvitationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeclineTransferRequestRequest": { + "type_name": "ApiDeclineTransferRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteAPIKeyRequest": { + "type_name": "ApiDeleteAPIKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteBatchRequest": { + "type_name": "ApiDeleteBatchRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "removeAssociatedInstances": { + "name": "removeAssociatedInstances", + "description": "" + } + } + }, + "ApiDeleteBgpDynamicNeighborByIdRequest": { + "type_name": "ApiDeleteBgpDynamicNeighborByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDeleteBgpSessionRequest": { + "type_name": "ApiDeleteBgpSessionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteDeviceRequest": { + "type_name": "ApiDeleteDeviceRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "forceDelete": { + "name": "forceDelete", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteEmailRequest": { + "type_name": "ApiDeleteEmailRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteIPAddressRequest": { + "type_name": "ApiDeleteIPAddressRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteInterconnectionRequest": { + "type_name": "ApiDeleteInterconnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDeleteLicenseRequest": { + "type_name": "ApiDeleteLicenseRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteMembershipRequest": { + "type_name": "ApiDeleteMembershipRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteMetalGatewayRequest": { + "type_name": "ApiDeleteMetalGatewayRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDeleteNativeVlanRequest": { + "type_name": "ApiDeleteNativeVlanRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDeleteOrganizationRequest": { + "type_name": "ApiDeleteOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeletePaymentMethodRequest": { + "type_name": "ApiDeletePaymentMethodRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteProjectRequest": { + "type_name": "ApiDeleteProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteSSHKeyRequest": { + "type_name": "ApiDeleteSSHKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteSpotMarketRequestRequest": { + "type_name": "ApiDeleteSpotMarketRequestRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "forceTermination": { + "name": "forceTermination", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteUserAPIKeyRequest": { + "type_name": "ApiDeleteUserAPIKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteVirtualCircuitRequest": { + "type_name": "ApiDeleteVirtualCircuitRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDeleteVirtualNetworkRequest": { + "type_name": "ApiDeleteVirtualNetworkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDeleteVrfRequest": { + "type_name": "ApiDeleteVrfRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiDeleteVrfRouteByIdRequest": { + "type_name": "ApiDeleteVrfRouteByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiDisableTfaAppRequest": { + "type_name": "ApiDisableTfaAppRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "xOtpToken": { + "name": "xOtpToken", + "description": "" + } + } + }, + "ApiDisbondPortRequest": { + "type_name": "ApiDisbondPortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bulkDisable": { + "name": "bulkDisable", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiEnableTfaAppRequest": { + "type_name": "ApiEnableTfaAppRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "xOtpToken": { + "name": "xOtpToken", + "description": "" + } + } + }, + "ApiFindAPIKeysRequest": { + "type_name": "ApiFindAPIKeysRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "search": { + "name": "search", + "description": "" + } + } + }, + "ApiFindBatchByIdRequest": { + "type_name": "ApiFindBatchByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindBatchesByProjectRequest": { + "type_name": "ApiFindBatchesByProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindBgpConfigByProjectRequest": { + "type_name": "ApiFindBgpConfigByProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindBgpSessionByIdRequest": { + "type_name": "ApiFindBgpSessionByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindBgpSessionsRequest": { + "type_name": "ApiFindBgpSessionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindCapacityForFacilityRequest": { + "type_name": "ApiFindCapacityForFacilityRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiFindCapacityForMetroRequest": { + "type_name": "ApiFindCapacityForMetroRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiFindCurrentUserRequest": { + "type_name": "ApiFindCurrentUserRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindDeviceByIdRequest": { + "type_name": "ApiFindDeviceByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindDeviceCustomdataRequest": { + "type_name": "ApiFindDeviceCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindDeviceEventsRequest": { + "type_name": "ApiFindDeviceEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindDeviceMetadataByIDRequest": { + "type_name": "ApiFindDeviceMetadataByIDRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindDeviceSSHKeysRequest": { + "type_name": "ApiFindDeviceSSHKeysRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "searchString": { + "name": "searchString", + "description": "" + } + } + }, + "ApiFindDeviceUsagesRequest": { + "type_name": "ApiFindDeviceUsagesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createdAfter": { + "name": "createdAfter", + "description": "" + }, + "createdBefore": { + "name": "createdBefore", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindDeviceUserdataByIDRequest": { + "type_name": "ApiFindDeviceUserdataByIDRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindEmailByIdRequest": { + "type_name": "ApiFindEmailByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindEventByIdRequest": { + "type_name": "ApiFindEventByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindEventsRequest": { + "type_name": "ApiFindEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindFacilitiesByOrganizationRequest": { + "type_name": "ApiFindFacilitiesByOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindFacilitiesByProjectRequest": { + "type_name": "ApiFindFacilitiesByProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindFacilitiesRequest": { + "type_name": "ApiFindFacilitiesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindGlobalBgpRangesRequest": { + "type_name": "ApiFindGlobalBgpRangesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindHardwareReservationByIdRequest": { + "type_name": "ApiFindHardwareReservationByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindIPAddressByIdRequest": { + "type_name": "ApiFindIPAddressByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindIPAddressCustomdataRequest": { + "type_name": "ApiFindIPAddressCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindIPAssignmentCustomdataRequest": { + "type_name": "ApiFindIPAssignmentCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "instanceId": { + "name": "instanceId", + "description": "" + } + } + }, + "ApiFindIPAssignmentsRequest": { + "type_name": "ApiFindIPAssignmentsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindIPAvailabilitiesRequest": { + "type_name": "ApiFindIPAvailabilitiesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cidr": { + "name": "cidr", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindIPReservationCustomdataRequest": { + "type_name": "ApiFindIPReservationCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiFindIPReservationsRequest": { + "type_name": "ApiFindIPReservationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "types": { + "name": "types", + "description": "" + } + } + }, + "ApiFindIncidentsRequest": { + "type_name": "ApiFindIncidentsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindInstanceBandwidthRequest": { + "type_name": "ApiFindInstanceBandwidthRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "from": { + "name": "from", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "until": { + "name": "until", + "description": "" + } + } + }, + "ApiFindInterconnectionEventsRequest": { + "type_name": "ApiFindInterconnectionEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindInterconnectionPortEventsRequest": { + "type_name": "ApiFindInterconnectionPortEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindInvitationByIdRequest": { + "type_name": "ApiFindInvitationByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindInvitationsRequest": { + "type_name": "ApiFindInvitationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindLicenseByIdRequest": { + "type_name": "ApiFindLicenseByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindMembershipByIdRequest": { + "type_name": "ApiFindMembershipByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindMetalGatewayByIdRequest": { + "type_name": "ApiFindMetalGatewayByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindMetalGatewaysByProjectRequest": { + "type_name": "ApiFindMetalGatewaysByProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiFindMetroSpotMarketPricesRequest": { + "type_name": "ApiFindMetroSpotMarketPricesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "metro": { + "name": "metro", + "description": "" + }, + "plan": { + "name": "plan", + "description": "" + } + } + }, + "ApiFindMetrosRequest": { + "type_name": "ApiFindMetrosRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiFindOperatingSystemVersionRequest": { + "type_name": "ApiFindOperatingSystemVersionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiFindOperatingSystemsByOrganizationRequest": { + "type_name": "ApiFindOperatingSystemsByOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindOperatingSystemsRequest": { + "type_name": "ApiFindOperatingSystemsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiFindOrganizationByIdRequest": { + "type_name": "ApiFindOrganizationByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindOrganizationCapacityPerFacilityRequest": { + "type_name": "ApiFindOrganizationCapacityPerFacilityRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindOrganizationCapacityPerMetroRequest": { + "type_name": "ApiFindOrganizationCapacityPerMetroRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindOrganizationCustomdataRequest": { + "type_name": "ApiFindOrganizationCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindOrganizationDevicesRequest": { + "type_name": "ApiFindOrganizationDevicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "categories": { + "name": "categories", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "facility": { + "name": "facility", + "description": "" + }, + "hasTerminationTime": { + "name": "hasTerminationTime", + "description": "" + }, + "hostname": { + "name": "hostname", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "macAddress": { + "name": "macAddress", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "reserved": { + "name": "reserved", + "description": "" + }, + "search": { + "name": "search", + "description": "" + }, + "tag": { + "name": "tag", + "description": "" + }, + "type_": { + "name": "type_", + "description": "" + } + } + }, + "ApiFindOrganizationEventsRequest": { + "type_name": "ApiFindOrganizationEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindOrganizationInvitationsRequest": { + "type_name": "ApiFindOrganizationInvitationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindOrganizationInvoicesRequest": { + "type_name": "ApiFindOrganizationInvoicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "status": { + "name": "status", + "description": "" + } + } + }, + "ApiFindOrganizationPaymentMethodsRequest": { + "type_name": "ApiFindOrganizationPaymentMethodsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindOrganizationProjectsRequest": { + "type_name": "ApiFindOrganizationProjectsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "name": { + "name": "name", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindOrganizationTransfersRequest": { + "type_name": "ApiFindOrganizationTransfersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindOrganizationsRequest": { + "type_name": "ApiFindOrganizationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "personal": { + "name": "personal", + "description": "" + }, + "withoutProjects": { + "name": "withoutProjects", + "description": "" + } + } + }, + "ApiFindPaymentMethodByIdRequest": { + "type_name": "ApiFindPaymentMethodByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindPlansByOrganizationRequest": { + "type_name": "ApiFindPlansByOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindPlansByProjectRequest": { + "type_name": "ApiFindPlansByProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindPlansRequest": { + "type_name": "ApiFindPlansRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "categories": { + "name": "categories", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "slug": { + "name": "slug", + "description": "" + }, + "type_": { + "name": "type_", + "description": "" + } + } + }, + "ApiFindPortByIdRequest": { + "type_name": "ApiFindPortByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindPortVlanAssignmentBatchByPortIdAndBatchIdRequest": { + "type_name": "ApiFindPortVlanAssignmentBatchByPortIdAndBatchIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "batchId": { + "name": "batchId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindPortVlanAssignmentBatchesRequest": { + "type_name": "ApiFindPortVlanAssignmentBatchesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindPortVlanAssignmentByPortIdAndAssignmentIdRequest": { + "type_name": "ApiFindPortVlanAssignmentByPortIdAndAssignmentIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "assignmentId": { + "name": "assignmentId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindPortVlanAssignmentsRequest": { + "type_name": "ApiFindPortVlanAssignmentsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindProjectAPIKeysRequest": { + "type_name": "ApiFindProjectAPIKeysRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindProjectBgpSessionsRequest": { + "type_name": "ApiFindProjectBgpSessionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindProjectByIdRequest": { + "type_name": "ApiFindProjectByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindProjectCustomdataRequest": { + "type_name": "ApiFindProjectCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindProjectDevicesRequest": { + "type_name": "ApiFindProjectDevicesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "categories": { + "name": "categories", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "facility": { + "name": "facility", + "description": "" + }, + "hasTerminationTime": { + "name": "hasTerminationTime", + "description": "" + }, + "hostname": { + "name": "hostname", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "macAddress": { + "name": "macAddress", + "description": "" + }, + "metro": { + "name": "metro", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "reserved": { + "name": "reserved", + "description": "" + }, + "search": { + "name": "search", + "description": "" + }, + "tag": { + "name": "tag", + "description": "" + }, + "type_": { + "name": "type_", + "description": "" + } + } + }, + "ApiFindProjectEventsRequest": { + "type_name": "ApiFindProjectEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindProjectHardwareReservationsRequest": { + "type_name": "ApiFindProjectHardwareReservationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "provisionable": { + "name": "provisionable", + "description": "" + }, + "query": { + "name": "query", + "description": "" + }, + "state": { + "name": "state", + "description": "" + } + } + }, + "ApiFindProjectInvitationsRequest": { + "type_name": "ApiFindProjectInvitationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiFindProjectLicensesRequest": { + "type_name": "ApiFindProjectLicensesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindProjectMembershipsRequest": { + "type_name": "ApiFindProjectMembershipsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + }, + "search": { + "name": "search", + "description": "" + } + } + }, + "ApiFindProjectSSHKeysRequest": { + "type_name": "ApiFindProjectSSHKeysRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "query": { + "name": "query", + "description": "" + } + } + }, + "ApiFindProjectUsageRequest": { + "type_name": "ApiFindProjectUsageRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "createdAfter": { + "name": "createdAfter", + "description": "" + }, + "createdBefore": { + "name": "createdBefore", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindProjectsRequest": { + "type_name": "ApiFindProjectsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "name": { + "name": "name", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindSSHKeyByIdRequest": { + "type_name": "ApiFindSSHKeyByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindSSHKeysRequest": { + "type_name": "ApiFindSSHKeysRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "search": { + "name": "search", + "description": "" + } + } + }, + "ApiFindSelfServiceReservationRequest": { + "type_name": "ApiFindSelfServiceReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiFindSelfServiceReservationsRequest": { + "type_name": "ApiFindSelfServiceReservationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "categories": { + "name": "categories", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiFindSpotMarketPricesHistoryRequest": { + "type_name": "ApiFindSpotMarketPricesHistoryRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "facility": { + "name": "facility", + "description": "" + }, + "from": { + "name": "from", + "description": "" + }, + "metro": { + "name": "metro", + "description": "" + }, + "plan": { + "name": "plan", + "description": "" + }, + "until": { + "name": "until", + "description": "" + } + } + }, + "ApiFindSpotMarketPricesRequest": { + "type_name": "ApiFindSpotMarketPricesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "facility": { + "name": "facility", + "description": "" + }, + "plan": { + "name": "plan", + "description": "" + } + } + }, + "ApiFindSpotMarketRequestByIdRequest": { + "type_name": "ApiFindSpotMarketRequestByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindTrafficRequest": { + "type_name": "ApiFindTrafficRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bucket": { + "name": "bucket", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "direction": { + "name": "direction", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "interval": { + "name": "interval", + "description": "" + }, + "timeframe": { + "name": "timeframe", + "description": "" + } + } + }, + "ApiFindTransferRequestByIdRequest": { + "type_name": "ApiFindTransferRequestByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindUserByIdRequest": { + "type_name": "ApiFindUserByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindUserCustomdataRequest": { + "type_name": "ApiFindUserCustomdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiFindUsersRequest": { + "type_name": "ApiFindUsersRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindVirtualCircuitEventsRequest": { + "type_name": "ApiFindVirtualCircuitEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindVirtualNetworksRequest": { + "type_name": "ApiFindVirtualNetworksRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "facility": { + "name": "facility", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "metro": { + "name": "metro", + "description": "" + } + } + }, + "ApiFindVrfByIdRequest": { + "type_name": "ApiFindVrfByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindVrfIpReservationRequest": { + "type_name": "ApiFindVrfIpReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vrfId": { + "name": "vrfId", + "description": "" + } + } + }, + "ApiFindVrfIpReservationsRequest": { + "type_name": "ApiFindVrfIpReservationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindVrfRouteByIdRequest": { + "type_name": "ApiFindVrfRouteByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiFindVrfRouteEventsRequest": { + "type_name": "ApiFindVrfRouteEventsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiFindVrfsRequest": { + "type_name": "ApiFindVrfsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "metro": { + "name": "metro", + "description": "" + } + } + }, + "ApiGetBgpDynamicNeighborsRequest": { + "type_name": "ApiGetBgpDynamicNeighborsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetBgpNeighborDataRequest": { + "type_name": "ApiGetBgpNeighborDataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetDeviceFirmwareSetsRequest": { + "type_name": "ApiGetDeviceFirmwareSetsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiGetDeviceHealthRollupRequest": { + "type_name": "ApiGetDeviceHealthRollupRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiGetInterconnectionMetrosRequest": { + "type_name": "ApiGetInterconnectionMetrosRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetInterconnectionPortRequest": { + "type_name": "ApiGetInterconnectionPortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetInterconnectionPricingRequest": { + "type_name": "ApiGetInterconnectionPricingRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiGetInterconnectionRequest": { + "type_name": "ApiGetInterconnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetInvoiceByIdRequest": { + "type_name": "ApiGetInvoiceByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiGetMetalGatewayElasticIpsRequest": { + "type_name": "ApiGetMetalGatewayElasticIpsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetMetroRequest": { + "type_name": "ApiGetMetroRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiGetOrganizationFirmwareSetsRequest": { + "type_name": "ApiGetOrganizationFirmwareSetsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiGetProjectFirmwareSetsRequest": { + "type_name": "ApiGetProjectFirmwareSetsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + } + } + }, + "ApiGetVirtualCircuitRequest": { + "type_name": "ApiGetVirtualCircuitRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetVirtualNetworkRequest": { + "type_name": "ApiGetVirtualNetworkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiGetVrfBGPNeighborsRequest": { + "type_name": "ApiGetVrfBGPNeighborsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiGetVrfLearnedRoutesRequest": { + "type_name": "ApiGetVrfLearnedRoutesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiGetVrfRoutesRequest": { + "type_name": "ApiGetVrfRoutesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiListInterconnectionPortVirtualCircuitsRequest": { + "type_name": "ApiListInterconnectionPortVirtualCircuitsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portId": { + "name": "portId", + "description": "" + } + } + }, + "ApiListInterconnectionPortsRequest": { + "type_name": "ApiListInterconnectionPortsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiListInterconnectionVirtualCircuitsRequest": { + "type_name": "ApiListInterconnectionVirtualCircuitsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiListSpotMarketRequestsRequest": { + "type_name": "ApiListSpotMarketRequestsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiMoveHardwareReservationRequest": { + "type_name": "ApiMoveHardwareReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "moveHardwareReservationRequest": { + "name": "moveHardwareReservationRequest", + "description": "" + } + } + }, + "ApiOrganizationListInterconnectionsRequest": { + "type_name": "ApiOrganizationListInterconnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "organizationId": { + "name": "organizationId", + "description": "" + } + } + }, + "ApiPerformActionRequest": { + "type_name": "ApiPerformActionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "deviceActionInput": { + "name": "deviceActionInput", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiProjectListInterconnectionsRequest": { + "type_name": "ApiProjectListInterconnectionsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "page": { + "name": "page", + "description": "" + }, + "perPage": { + "name": "perPage", + "description": "" + }, + "projectId": { + "name": "projectId", + "description": "" + } + } + }, + "ApiRequestBgpConfigRequest": { + "type_name": "ApiRequestBgpConfigRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "bgpConfigRequestInput": { + "name": "bgpConfigRequestInput", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiRequestIPReservationRequest": { + "type_name": "ApiRequestIPReservationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "requestIPReservationRequest": { + "name": "requestIPReservationRequest", + "description": "" + } + } + }, + "ApiRequestSupportRequest": { + "type_name": "ApiRequestSupportRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "supportRequestInput": { + "name": "supportRequestInput", + "description": "" + } + } + }, + "ApiResetPasswordRequest": { + "type_name": "ApiResetPasswordRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiUnassignPortRequest": { + "type_name": "ApiUnassignPortRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "portAssignInput": { + "name": "portAssignInput", + "description": "" + } + } + }, + "ApiUpdateBgpSessionRequest": { + "type_name": "ApiUpdateBgpSessionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + } + } + }, + "ApiUpdateCurrentUserRequest": { + "type_name": "ApiUpdateCurrentUserRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "userUpdateInput": { + "name": "userUpdateInput", + "description": "" + } + } + }, + "ApiUpdateDeviceRequest": { + "type_name": "ApiUpdateDeviceRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "deviceUpdateInput": { + "name": "deviceUpdateInput", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiUpdateEmailRequest": { + "type_name": "ApiUpdateEmailRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "updateEmailInput": { + "name": "updateEmailInput", + "description": "" + } + } + }, + "ApiUpdateIPAddressRequest": { + "type_name": "ApiUpdateIPAddressRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "iPAssignmentUpdateInput": { + "name": "iPAssignmentUpdateInput", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + } + } + }, + "ApiUpdateInterconnectionRequest": { + "type_name": "ApiUpdateInterconnectionRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "connectionId": { + "name": "connectionId", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "interconnectionUpdateInput": { + "name": "interconnectionUpdateInput", + "description": "" + } + } + }, + "ApiUpdateLicenseRequest": { + "type_name": "ApiUpdateLicenseRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "licenseUpdateInput": { + "name": "licenseUpdateInput", + "description": "" + } + } + }, + "ApiUpdateMembershipRequest": { + "type_name": "ApiUpdateMembershipRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "membershipInput": { + "name": "membershipInput", + "description": "" + } + } + }, + "ApiUpdateOrganizationRequest": { + "type_name": "ApiUpdateOrganizationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "organizationInput": { + "name": "organizationInput", + "description": "" + } + } + }, + "ApiUpdatePaymentMethodRequest": { + "type_name": "ApiUpdatePaymentMethodRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "paymentMethodUpdateInput": { + "name": "paymentMethodUpdateInput", + "description": "" + } + } + }, + "ApiUpdateProjectRequest": { + "type_name": "ApiUpdateProjectRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "projectUpdateInput": { + "name": "projectUpdateInput", + "description": "" + } + } + }, + "ApiUpdateSSHKeyRequest": { + "type_name": "ApiUpdateSSHKeyRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "sSHKeyInput": { + "name": "sSHKeyInput", + "description": "" + } + } + }, + "ApiUpdateVirtualCircuitRequest": { + "type_name": "ApiUpdateVirtualCircuitRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "virtualCircuitUpdateInput": { + "name": "virtualCircuitUpdateInput", + "description": "" + } + } + }, + "ApiUpdateVirtualNetworkRequest": { + "type_name": "ApiUpdateVirtualNetworkRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "virtualNetworkUpdateInput": { + "name": "virtualNetworkUpdateInput", + "description": "" + } + } + }, + "ApiUpdateVrfRequest": { + "type_name": "ApiUpdateVrfRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vrfUpdateInput": { + "name": "vrfUpdateInput", + "description": "" + } + } + }, + "ApiUpdateVrfRouteByIdRequest": { + "type_name": "ApiUpdateVrfRouteByIdRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "exclude": { + "name": "exclude", + "description": "" + }, + "id": { + "name": "id", + "description": "" + }, + "include": { + "name": "include", + "description": "" + }, + "vrfRouteUpdateInput": { + "name": "vrfRouteUpdateInput", + "description": "" + } + } + }, + "ApiValidateUserdataRequest": { + "type_name": "ApiValidateUserdataRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "userdata": { + "name": "userdata", + "description": "" + } + } + }, + "Attribute": { + "type_name": "Attribute", + "description": "Attribute struct for Attribute", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "Datetime when the block was created.", + "json_tag": "created_at" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "Namespace": { + "name": "Namespace", + "description": "Attribute namespace", + "json_tag": "namespace" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "Datetime when the block was updated.", + "json_tag": "updated_at" + } + } + }, + "AttributeData": { + "type_name": "AttributeData", + "description": "AttributeData struct for AttributeData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Latest": { + "name": "Latest", + "description": "Boolean flag to know if the firmware set is the latest for the model and vendor", + "json_tag": "latest" + }, + "Model": { + "name": "Model", + "description": "Model on which this firmware set can be applied", + "json_tag": "model" + }, + "Plan": { + "name": "Plan", + "description": "Plan where the firmware set can be applied", + "json_tag": "plan" + }, + "Vendor": { + "name": "Vendor", + "description": "Vendor on which this firmware set can be applied", + "json_tag": "vendor" + } + } + }, + "AuthToken": { + "type_name": "AuthToken", + "description": "AuthToken struct for AuthToken", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Description": { + "name": "Description", + "description": "Available only for API keys", + "json_tag": "description" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "ReadOnly": { + "name": "ReadOnly", + "description": "", + "json_tag": "read_only" + }, + "Token": { + "name": "Token", + "description": "", + "json_tag": "token" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "User": { + "name": "User", + "description": "", + "json_tag": "user" + } + } + }, + "AuthTokenInput": { + "type_name": "AuthTokenInput", + "description": "AuthTokenInput struct for AuthTokenInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "ReadOnly": { + "name": "ReadOnly", + "description": "", + "json_tag": "read_only" + } + } + }, + "AuthTokenList": { + "type_name": "AuthTokenList", + "description": "AuthTokenList struct for AuthTokenList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ApiKeys": { + "name": "ApiKeys", + "description": "", + "json_tag": "api_keys" + } + } + }, + "AuthTokenProject": { + "type_name": "AuthTokenProject", + "description": "AuthTokenProject struct for AuthTokenProject", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BackendTransferEnabled": { + "name": "BackendTransferEnabled", + "description": "", + "json_tag": "backend_transfer_enabled" + }, + "BgpConfig": { + "name": "BgpConfig", + "description": "", + "json_tag": "bgp_config" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Devices": { + "name": "Devices", + "description": "", + "json_tag": "devices" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Invitations": { + "name": "Invitations", + "description": "", + "json_tag": "invitations" + }, + "MaxDevices": { + "name": "MaxDevices", + "description": "", + "json_tag": "max_devices" + }, + "Members": { + "name": "Members", + "description": "", + "json_tag": "members" + }, + "Memberships": { + "name": "Memberships", + "description": "", + "json_tag": "memberships" + }, + "Name": { + "name": "Name", + "description": "The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis.", + "json_tag": "name" + }, + "NetworkStatus": { + "name": "NetworkStatus", + "description": "", + "json_tag": "network_status" + }, + "Organization": { + "name": "Organization", + "description": "", + "json_tag": "organization" + }, + "PaymentMethod": { + "name": "PaymentMethod", + "description": "", + "json_tag": "payment_method" + }, + "SshKeys": { + "name": "SshKeys", + "description": "", + "json_tag": "ssh_keys" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "Url": { + "name": "Url", + "description": "", + "json_tag": "url" + }, + "Volumes": { + "name": "Volumes", + "description": "", + "json_tag": "volumes" + } + } + }, + "AuthTokenUser": { + "type_name": "AuthTokenUser", + "description": "AuthTokenUser struct for AuthTokenUser", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AvatarThumbUrl": { + "name": "AvatarThumbUrl", + "description": "", + "json_tag": "avatar_thumb_url" + }, + "AvatarUrl": { + "name": "AvatarUrl", + "description": "", + "json_tag": "avatar_url" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "DefaultOrganizationId": { + "name": "DefaultOrganizationId", + "description": "", + "json_tag": "default_organization_id" + }, + "DefaultProjectId": { + "name": "DefaultProjectId", + "description": "", + "json_tag": "default_project_id" + }, + "Email": { + "name": "Email", + "description": "", + "json_tag": "email" + }, + "Emails": { + "name": "Emails", + "description": "", + "json_tag": "emails" + }, + "FirstName": { + "name": "FirstName", + "description": "", + "json_tag": "first_name" + }, + "FraudScore": { + "name": "FraudScore", + "description": "", + "json_tag": "fraud_score" + }, + "FullName": { + "name": "FullName", + "description": "", + "json_tag": "full_name" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "LastLoginAt": { + "name": "LastLoginAt", + "description": "", + "json_tag": "last_login_at" + }, + "LastName": { + "name": "LastName", + "description": "", + "json_tag": "last_name" + }, + "MaxOrganizations": { + "name": "MaxOrganizations", + "description": "", + "json_tag": "max_organizations" + }, + "MaxProjects": { + "name": "MaxProjects", + "description": "", + "json_tag": "max_projects" + }, + "PhoneNumber": { + "name": "PhoneNumber", + "description": "", + "json_tag": "phone_number" + }, + "ShortId": { + "name": "ShortId", + "description": "", + "json_tag": "short_id" + }, + "Timezone": { + "name": "Timezone", + "description": "", + "json_tag": "timezone" + }, + "TwoFactorAuth": { + "name": "TwoFactorAuth", + "description": "", + "json_tag": "two_factor_auth" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + } + } + }, + "BGPSessionInput": { + "type_name": "BGPSessionInput", + "description": "BGPSessionInput struct for BGPSessionInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AddressFamily": { + "name": "AddressFamily", + "description": "", + "json_tag": "address_family" + }, + "DefaultRoute": { + "name": "DefaultRoute", + "description": "Set the default route policy.", + "json_tag": "default_route" + } + } + }, + "BasicAuth": { + "type_name": "BasicAuth", + "description": "BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth", + "fields": { + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "UserName": { + "name": "UserName", + "description": "", + "json_tag": "userName" + } + } + }, + "Batch": { + "type_name": "Batch", + "description": "Batch struct for Batch", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Devices": { + "name": "Devices", + "description": "", + "json_tag": "devices" + }, + "ErrorMessages": { + "name": "ErrorMessages", + "description": "", + "json_tag": "error_messages" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Quantity": { + "name": "Quantity", + "description": "", + "json_tag": "quantity" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + } + } + }, + "BatchesList": { + "type_name": "BatchesList", + "description": "BatchesList struct for BatchesList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Batches": { + "name": "Batches", + "description": "", + "json_tag": "batches" + } + } + }, + "BgpConfig": { + "type_name": "BgpConfig", + "description": "BgpConfig struct for BgpConfig", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Asn": { + "name": "Asn", + "description": "Autonomous System Number. ASN is required with Global BGP. With Local BGP the private ASN, 65000, is assigned.", + "json_tag": "asn" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "DeploymentType": { + "name": "DeploymentType", + "description": "", + "json_tag": "deployment_type" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "MaxPrefix": { + "name": "MaxPrefix", + "description": "The maximum number of route filters allowed per server", + "json_tag": "max_prefix" + }, + "Md5": { + "name": "Md5", + "description": "(Optional) Password for BGP session in plaintext (not a checksum)", + "json_tag": "md5" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Ranges": { + "name": "Ranges", + "description": "The IP block ranges associated to the ASN (Populated in Global BGP only)", + "json_tag": "ranges" + }, + "RequestedAt": { + "name": "RequestedAt", + "description": "", + "json_tag": "requested_at" + }, + "RouteObject": { + "name": "RouteObject", + "description": "Specifies AS-MACRO (aka AS-SET) to use when building client route filters", + "json_tag": "route_object" + }, + "Sessions": { + "name": "Sessions", + "description": "The direct connections between neighboring routers that want to exchange routing information.", + "json_tag": "sessions" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + } + } + }, + "BgpConfigRequestInput": { + "type_name": "BgpConfigRequestInput", + "description": "BgpConfigRequestInput struct for BgpConfigRequestInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Asn": { + "name": "Asn", + "description": "Autonomous System Number for local BGP deployment.", + "json_tag": "asn" + }, + "DeploymentType": { + "name": "DeploymentType", + "description": "", + "json_tag": "deployment_type" + }, + "Md5": { + "name": "Md5", + "description": "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", + "json_tag": "md5" + }, + "UseCase": { + "name": "UseCase", + "description": "A use case explanation (necessary for global BGP request review).", + "json_tag": "use_case" + } + } + }, + "BgpDynamicNeighbor": { + "type_name": "BgpDynamicNeighbor", + "description": "BgpDynamicNeighbor struct for BgpDynamicNeighbor", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpNeighborAsn": { + "name": "BgpNeighborAsn", + "description": "The ASN of the dynamic BGP neighbor", + "json_tag": "bgp_neighbor_asn" + }, + "BgpNeighborRange": { + "name": "BgpNeighborRange", + "description": "Network range of the dynamic BGP neighbor in CIDR format", + "json_tag": "bgp_neighbor_range" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "", + "json_tag": "created_by" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "The unique identifier for the resource", + "json_tag": "id" + }, + "MetalGateway": { + "name": "MetalGateway", + "description": "", + "json_tag": "metal_gateway" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + } + } + }, + "BgpDynamicNeighborCreateInput": { + "type_name": "BgpDynamicNeighborCreateInput", + "description": "BgpDynamicNeighborCreateInput struct for BgpDynamicNeighborCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpNeighborAsn": { + "name": "BgpNeighborAsn", + "description": "The ASN of the dynamic BGP neighbor", + "json_tag": "bgp_neighbor_asn" + }, + "BgpNeighborRange": { + "name": "BgpNeighborRange", + "description": "Network range of the dynamic BGP neighbor in CIDR format", + "json_tag": "bgp_neighbor_range" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "BgpDynamicNeighborList": { + "type_name": "BgpDynamicNeighborList", + "description": "BgpDynamicNeighborList struct for BgpDynamicNeighborList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpDynamicNeighbors": { + "name": "BgpDynamicNeighbors", + "description": "", + "json_tag": "bgp_dynamic_neighbors" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + } + } + }, + "BgpNeighborData": { + "type_name": "BgpNeighborData", + "description": "BgpNeighborData struct for BgpNeighborData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AddressFamily": { + "name": "AddressFamily", + "description": "Address Family for IP Address. Accepted values are 4 or 6", + "json_tag": "address_family" + }, + "CustomerAs": { + "name": "CustomerAs", + "description": "The customer's ASN. In a local BGP deployment, this will be an internal ASN used to route within the data center. For a global BGP deployment, this will be the your own ASN, configured when you set up BGP for your project.", + "json_tag": "customer_as" + }, + "CustomerIp": { + "name": "CustomerIp", + "description": "The device's IP address. For an IPv4 BGP session, this is typically the private bond0 address for the device.", + "json_tag": "customer_ip" + }, + "Md5Enabled": { + "name": "Md5Enabled", + "description": "True if an MD5 password is configured for the project.", + "json_tag": "md5_enabled" + }, + "Md5Password": { + "name": "Md5Password", + "description": "The MD5 password configured for the project, if set.", + "json_tag": "md5_password" + }, + "Multihop": { + "name": "Multihop", + "description": "True when the BGP session should be configured as multihop.", + "json_tag": "multihop" + }, + "PeerAs": { + "name": "PeerAs", + "description": "The Peer ASN to use when configuring BGP on your device.", + "json_tag": "peer_as" + }, + "PeerIps": { + "name": "PeerIps", + "description": "A list of one or more IP addresses to use for the Peer IP section of your BGP configuration. For non-multihop sessions, this will typically be a single gateway address for the device. For multihop sessions, it will be a list of IPs.", + "json_tag": "peer_ips" + }, + "RoutesIn": { + "name": "RoutesIn", + "description": "A list of project subnets", + "json_tag": "routes_in" + }, + "RoutesOut": { + "name": "RoutesOut", + "description": "A list of outgoing routes. Only populated if the BGP session has default route enabled.", + "json_tag": "routes_out" + } + } + }, + "BgpRoute": { + "type_name": "BgpRoute", + "description": "BgpRoute struct for BgpRoute", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Exact": { + "name": "Exact", + "description": "", + "json_tag": "exact" + }, + "Route": { + "name": "Route", + "description": "", + "json_tag": "route" + } + } + }, + "BgpSession": { + "type_name": "BgpSession", + "description": "BgpSession struct for BgpSession", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AddressFamily": { + "name": "AddressFamily", + "description": "", + "json_tag": "address_family" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "DefaultRoute": { + "name": "DefaultRoute", + "description": "", + "json_tag": "default_route" + }, + "Device": { + "name": "Device", + "description": "", + "json_tag": "device" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "LearnedRoutes": { + "name": "LearnedRoutes", + "description": "", + "json_tag": "learned_routes" + }, + "Status": { + "name": "Status", + "description": "The status of the BGP Session. Multiple status values may be reported when the device is connected to multiple switches, one value per switch. Each status will start with \\\"unknown\\\" and progress to \\\"up\\\" or \\\"down\\\" depending on the connected device. Subsequent \\\"unknown\\\" values indicate a problem acquiring status from the switch.", + "json_tag": "status" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + } + } + }, + "BgpSessionList": { + "type_name": "BgpSessionList", + "description": "BgpSessionList struct for BgpSessionList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpSessions": { + "name": "BgpSessions", + "description": "", + "json_tag": "bgp_sessions" + } + } + }, + "BgpSessionNeighbors": { + "type_name": "BgpSessionNeighbors", + "description": "BgpSessionNeighbors struct for BgpSessionNeighbors", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpNeighbors": { + "name": "BgpNeighbors", + "description": "A list of BGP session neighbor data", + "json_tag": "bgp_neighbors" + } + } + }, + "BondPortData": { + "type_name": "BondPortData", + "description": "BondPortData struct for BondPortData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Id": { + "name": "Id", + "description": "ID of the bonding port", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "Name of the port interface for the bond (\\\"bond0\\\")", + "json_tag": "name" + } + } + }, + "CapacityCheckPerFacilityInfo": { + "type_name": "CapacityCheckPerFacilityInfo", + "description": "CapacityCheckPerFacilityInfo struct for CapacityCheckPerFacilityInfo", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Available": { + "name": "Available", + "description": "", + "json_tag": "available" + }, + "Facility": { + "name": "Facility", + "description": "", + "json_tag": "facility" + }, + "Plan": { + "name": "Plan", + "description": "", + "json_tag": "plan" + }, + "Quantity": { + "name": "Quantity", + "description": "", + "json_tag": "quantity" + } + } + }, + "CapacityCheckPerFacilityList": { + "type_name": "CapacityCheckPerFacilityList", + "description": "CapacityCheckPerFacilityList struct for CapacityCheckPerFacilityList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Servers": { + "name": "Servers", + "description": "", + "json_tag": "servers" + } + } + }, + "CapacityCheckPerMetroInfo": { + "type_name": "CapacityCheckPerMetroInfo", + "description": "CapacityCheckPerMetroInfo struct for CapacityCheckPerMetroInfo", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Available": { + "name": "Available", + "description": "Returns true if there is enough capacity in the metro to fulfill the quantity set. Returns false if there is not enough.", + "json_tag": "available" + }, + "Metro": { + "name": "Metro", + "description": "The metro ID or code sent to check capacity.", + "json_tag": "metro" + }, + "Plan": { + "name": "Plan", + "description": "The plan ID or slug sent to check capacity.", + "json_tag": "plan" + }, + "Quantity": { + "name": "Quantity", + "description": "The number of servers sent to check capacity.", + "json_tag": "quantity" + } + } + }, + "CapacityCheckPerMetroList": { + "type_name": "CapacityCheckPerMetroList", + "description": "CapacityCheckPerMetroList struct for CapacityCheckPerMetroList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Servers": { + "name": "Servers", + "description": "", + "json_tag": "servers" + } + } + }, + "CapacityInput": { + "type_name": "CapacityInput", + "description": "CapacityInput struct for CapacityInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Servers": { + "name": "Servers", + "description": "", + "json_tag": "servers" + } + } + }, + "CapacityLevelPerBaremetal": { + "type_name": "CapacityLevelPerBaremetal", + "description": "CapacityLevelPerBaremetal struct for CapacityLevelPerBaremetal", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Level": { + "name": "Level", + "description": "", + "json_tag": "level" + } + } + }, + "CapacityList": { + "type_name": "CapacityList", + "description": "CapacityList struct for CapacityList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Capacity": { + "name": "Capacity", + "description": "", + "json_tag": "capacity" + } + } + }, + "Component": { + "type_name": "Component", + "description": "Component struct for Component", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Checksum": { + "name": "Checksum", + "description": "File checksum", + "json_tag": "checksum" + }, + "Component": { + "name": "Component", + "description": "Component type", + "json_tag": "component" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "Datetime when the block was created.", + "json_tag": "created_at" + }, + "Filename": { + "name": "Filename", + "description": "name of the file", + "json_tag": "filename" + }, + "Model": { + "name": "Model", + "description": "List of models where this component version can be applied", + "json_tag": "model" + }, + "RepositoryUrl": { + "name": "RepositoryUrl", + "description": "Location of the file in the repository", + "json_tag": "repository_url" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "Datetime when the block was updated.", + "json_tag": "updated_at" + }, + "UpstreamUrl": { + "name": "UpstreamUrl", + "description": "Location of the file", + "json_tag": "upstream_url" + }, + "Uuid": { + "name": "Uuid", + "description": "Component UUID", + "json_tag": "uuid" + }, + "Vendor": { + "name": "Vendor", + "description": "Component vendor", + "json_tag": "vendor" + }, + "Version": { + "name": "Version", + "description": "Version of the component", + "json_tag": "version" + } + } + }, + "Configuration": { + "type_name": "Configuration", + "description": "Configuration stores the configuration of the API client", + "fields": { + "Debug": { + "name": "Debug", + "description": "", + "json_tag": "debug" + }, + "DefaultHeader": { + "name": "DefaultHeader", + "description": "", + "json_tag": "defaultHeader" + }, + "HTTPClient": { + "name": "HTTPClient", + "description": "" + }, + "Host": { + "name": "Host", + "description": "", + "json_tag": "host" + }, + "OperationServers": { + "name": "OperationServers", + "description": "" + }, + "Scheme": { + "name": "Scheme", + "description": "", + "json_tag": "scheme" + }, + "Servers": { + "name": "Servers", + "description": "" + }, + "UserAgent": { + "name": "UserAgent", + "description": "", + "json_tag": "userAgent" + } + } + }, + "Coordinates": { + "type_name": "Coordinates", + "description": "Coordinates struct for Coordinates", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Latitude": { + "name": "Latitude", + "description": "", + "json_tag": "latitude" + }, + "Longitude": { + "name": "Longitude", + "description": "", + "json_tag": "longitude" + } + } + }, + "CreateDeviceRequest": { + "type_name": "CreateDeviceRequest", + "description": "CreateDeviceRequest - struct for CreateDeviceRequest", + "fields": { + "DeviceCreateInFacilityInput": { + "name": "DeviceCreateInFacilityInput", + "description": "" + }, + "DeviceCreateInMetroInput": { + "name": "DeviceCreateInMetroInput", + "description": "" + } + } + }, + "CreateEmailInput": { + "type_name": "CreateEmailInput", + "description": "CreateEmailInput struct for CreateEmailInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + } + } + }, + "CreateMetalGatewayRequest": { + "type_name": "CreateMetalGatewayRequest", + "description": "CreateMetalGatewayRequest - struct for CreateMetalGatewayRequest", + "fields": { + "MetalGatewayCreateInput": { + "name": "MetalGatewayCreateInput", + "description": "" + }, + "VrfMetalGatewayCreateInput": { + "name": "VrfMetalGatewayCreateInput", + "description": "" + } + } + }, + "CreateOrganizationInterconnectionRequest": { + "type_name": "CreateOrganizationInterconnectionRequest", + "description": "CreateOrganizationInterconnectionRequest - struct for CreateOrganizationInterconnectionRequest", + "fields": { + "DedicatedPortCreateInput": { + "name": "DedicatedPortCreateInput", + "description": "" + }, + "SharedPortVCVlanCreateInput": { + "name": "SharedPortVCVlanCreateInput", + "description": "" + }, + "VlanCSPConnectionCreateInput": { + "name": "VlanCSPConnectionCreateInput", + "description": "" + }, + "VlanFabricVcCreateInput": { + "name": "VlanFabricVcCreateInput", + "description": "" + }, + "VrfFabricVcCreateInput": { + "name": "VrfFabricVcCreateInput", + "description": "" + } + } + }, + "CreateSelfServiceReservationRequest": { + "type_name": "CreateSelfServiceReservationRequest", + "description": "CreateSelfServiceReservationRequest struct for CreateSelfServiceReservationRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Item": { + "name": "Item", + "description": "", + "json_tag": "item" + }, + "Notes": { + "name": "Notes", + "description": "", + "json_tag": "notes" + }, + "Period": { + "name": "Period", + "description": "", + "json_tag": "period" + }, + "StartDate": { + "name": "StartDate", + "description": "", + "json_tag": "start_date" + } + } + }, + "CreateSelfServiceReservationRequestPeriod": { + "type_name": "CreateSelfServiceReservationRequestPeriod", + "description": "CreateSelfServiceReservationRequestPeriod struct for CreateSelfServiceReservationRequestPeriod", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Count": { + "name": "Count", + "description": "", + "json_tag": "count" + }, + "Unit": { + "name": "Unit", + "description": "", + "json_tag": "unit" + } + } + }, + "DedicatedPortCreateInput": { + "type_name": "DedicatedPortCreateInput", + "description": "DedicatedPortCreateInput struct for DedicatedPortCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BillingAccountName": { + "name": "BillingAccountName", + "description": "The billing account name of the Equinix Fabric account.", + "json_tag": "billing_account_name" + }, + "ContactEmail": { + "name": "ContactEmail", + "description": "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.", + "json_tag": "contact_email" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "FacilityId": { + "name": "FacilityId", + "description": "", + "json_tag": "facility_id" + }, + "Metro": { + "name": "Metro", + "description": "A Metro ID or code. For interconnections with Dedicated Ports, this will be the location of the issued Dedicated Ports.", + "json_tag": "metro" + }, + "Mode": { + "name": "Mode", + "description": "", + "json_tag": "mode" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Redundancy": { + "name": "Redundancy", + "description": "Either 'primary' or 'redundant'.", + "json_tag": "redundancy" + }, + "Speed": { + "name": "Speed", + "description": "A interconnection speed, in bps, mbps, or gbps. For Dedicated Ports, this can be 10Gbps or 100Gbps.", + "json_tag": "speed" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UseCase": { + "name": "UseCase", + "description": "The intended use case of the dedicated port.", + "json_tag": "use_case" + } + } + }, + "Device": { + "type_name": "Device", + "description": "Device struct for Device", + "fields": { + "Actions": { + "name": "Actions", + "description": "Actions supported by the device instance.", + "json_tag": "actions" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AlwaysPxe": { + "name": "AlwaysPxe", + "description": "", + "json_tag": "always_pxe" + }, + "BillingCycle": { + "name": "BillingCycle", + "description": "", + "json_tag": "billing_cycle" + }, + "BondingMode": { + "name": "BondingMode", + "description": "", + "json_tag": "bonding_mode" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "", + "json_tag": "created_by" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Facility": { + "name": "Facility", + "description": "", + "json_tag": "facility" + }, + "FirmwareSetId": { + "name": "FirmwareSetId", + "description": "The UUID of the firmware set to associate with the device.", + "json_tag": "firmware_set_id" + }, + "HardwareReservation": { + "name": "HardwareReservation", + "description": "", + "json_tag": "hardware_reservation" + }, + "Hostname": { + "name": "Hostname", + "description": "", + "json_tag": "hostname" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "ImageUrl": { + "name": "ImageUrl", + "description": "", + "json_tag": "image_url" + }, + "IpAddresses": { + "name": "IpAddresses", + "description": "", + "json_tag": "ip_addresses" + }, + "IpxeScriptUrl": { + "name": "IpxeScriptUrl", + "description": "", + "json_tag": "ipxe_script_url" + }, + "Iqn": { + "name": "Iqn", + "description": "", + "json_tag": "iqn" + }, + "Locked": { + "name": "Locked", + "description": "Prevents accidental deletion of this resource when set to true.", + "json_tag": "locked" + }, + "Metro": { + "name": "Metro", + "description": "", + "json_tag": "metro" + }, + "NetworkFrozen": { + "name": "NetworkFrozen", + "description": "Whether network mode changes such as converting to/from Layer2 or Layer3 networking, bonding or disbonding network interfaces are permitted for the device.", + "json_tag": "network_frozen" + }, + "NetworkPorts": { + "name": "NetworkPorts", + "description": "By default, servers at Equinix Metal are configured in a “bonded” mode using LACP (Link Aggregation Control Protocol). Each 2-NIC server is configured with a single bond (namely bond0) with both interfaces eth0 and eth1 as members of the bond in a default Layer 3 mode. Some device plans may have a different number of ports and bonds available.", + "json_tag": "network_ports" + }, + "OperatingSystem": { + "name": "OperatingSystem", + "description": "", + "json_tag": "operating_system" + }, + "Plan": { + "name": "Plan", + "description": "", + "json_tag": "plan" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "ProjectLite": { + "name": "ProjectLite", + "description": "", + "json_tag": "project_lite" + }, + "ProvisioningEvents": { + "name": "ProvisioningEvents", + "description": "", + "json_tag": "provisioning_events" + }, + "ProvisioningPercentage": { + "name": "ProvisioningPercentage", + "description": "Only visible while device provisioning", + "json_tag": "provisioning_percentage" + }, + "RootPassword": { + "name": "RootPassword", + "description": "Root password is automatically generated when server is provisioned and it is removed after 24 hours", + "json_tag": "root_password" + }, + "ShortId": { + "name": "ShortId", + "description": "", + "json_tag": "short_id" + }, + "Sos": { + "name": "Sos", + "description": "Hostname used to connect to the instance via the SOS (Serial over SSH) out-of-band console.", + "json_tag": "sos" + }, + "SpotInstance": { + "name": "SpotInstance", + "description": "Whether or not the device is a spot instance.", + "json_tag": "spot_instance" + }, + "SpotPriceMax": { + "name": "SpotPriceMax", + "description": "The maximum price per hour you are willing to pay to keep this spot instance. If you are outbid, the termination will be set allowing two minutes before shutdown.", + "json_tag": "spot_price_max" + }, + "SshKeys": { + "name": "SshKeys", + "description": "", + "json_tag": "ssh_keys" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Storage": { + "name": "Storage", + "description": "", + "json_tag": "storage" + }, + "SwitchUuid": { + "name": "SwitchUuid", + "description": "Switch short id. This can be used to determine if two devices are connected to the same switch, for example.", + "json_tag": "switch_uuid" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "TerminationTime": { + "name": "TerminationTime", + "description": "When the device will be terminated. If you don't supply timezone info, the timestamp is assumed to be in UTC. This is commonly set in advance for ephemeral spot market instances but this field may also be set with on-demand and reservation instances to automatically delete the resource at a given time. The termination time can also be used to release a hardware reservation instance at a given time, keeping the reservation open for other uses. On a spot market device, the termination time will be set automatically when outbid.", + "json_tag": "termination_time" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "User": { + "name": "User", + "description": "", + "json_tag": "user" + }, + "Userdata": { + "name": "Userdata", + "description": "", + "json_tag": "userdata" + }, + "Volumes": { + "name": "Volumes", + "description": "", + "json_tag": "volumes" + } + } + }, + "DeviceActionInput": { + "type_name": "DeviceActionInput", + "description": "DeviceActionInput struct for DeviceActionInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeprovisionFast": { + "name": "DeprovisionFast", + "description": "When type is `reinstall`, enabling fast deprovisioning will bypass full disk wiping.", + "json_tag": "deprovision_fast" + }, + "ForceDelete": { + "name": "ForceDelete", + "description": "May be required to perform actions under certain conditions", + "json_tag": "force_delete" + }, + "IpxeScriptUrl": { + "name": "IpxeScriptUrl", + "description": "When type is `reinstall`, use this `ipxe_script_url` (`operating_system` must be `custom_ipxe`, defaults to the current `ipxe_script_url`)", + "json_tag": "ipxe_script_url" + }, + "OperatingSystem": { + "name": "OperatingSystem", + "description": "When type is `reinstall`, use this `operating_system` (defaults to the current `operating system`)", + "json_tag": "operating_system" + }, + "PreserveData": { + "name": "PreserveData", + "description": "When type is `reinstall`, preserve the existing data on all disks except the operating-system disk.", + "json_tag": "preserve_data" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "DeviceActionsInner": { + "type_name": "DeviceActionsInner", + "description": "DeviceActionsInner struct for DeviceActionsInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "DeviceCreateInFacilityInput": { + "type_name": "DeviceCreateInFacilityInput", + "description": "DeviceCreateInFacilityInput struct for DeviceCreateInFacilityInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AlwaysPxe": { + "name": "AlwaysPxe", + "description": "When true, devices with a `custom_ipxe` OS will always boot to iPXE. The default setting of false ensures that iPXE will be used on only the first boot.", + "json_tag": "always_pxe" + }, + "BillingCycle": { + "name": "BillingCycle", + "description": "", + "json_tag": "billing_cycle" + }, + "Customdata": { + "name": "Customdata", + "description": "Customdata is an arbitrary JSON value that can be accessed via the metadata service.", + "json_tag": "customdata" + }, + "Description": { + "name": "Description", + "description": "Any description of the device or how it will be used. This may be used to inform other API consumers with project access.", + "json_tag": "description" + }, + "Facility": { + "name": "Facility", + "description": "The datacenter where the device should be created. Either metro or facility must be provided. The API will accept either a single facility `{ \\\"facility\\\": \\\"f1\\\" }`, or it can be instructed to create the device in the best available datacenter `{ \\\"facility\\\": \\\"any\\\" }`. Additionally it is possible to set a prioritized location selection. For example `{ \\\"facility\\\": [\\\"f3\\\", \\\"f2\\\", \\\"any\\\"] }` can be used to prioritize `f3` and then `f2` before accepting `any` facility. If none of the facilities provided have availability for the requested device the request will fail.\nDeprecated", + "json_tag": "facility" + }, + "Features": { + "name": "Features", + "description": "The features attribute allows you to optionally specify what features your server should have. In the API shorthand syntax, all features listed are `required`: ``` { \\\"features\\\": [\\\"tpm\\\"] } ``` Alternatively, if you do not require a certain feature, but would prefer to be assigned a server with that feature if there are any available, you may specify that feature with a `preferred` value. The request will not fail if we have no servers with that feature in our inventory. The API offers an alternative syntax for mixing preferred and required features: ``` { \\\"features\\\": { \\\"tpm\\\": \\\"required\\\", \\\"raid\\\": \\\"preferred\\\" } } ``` The request will only fail if there are no available servers matching the required `tpm` criteria.", + "json_tag": "features" + }, + "HardwareReservationId": { + "name": "HardwareReservationId", + "description": "The Hardware Reservation UUID to provision. Alternatively, `next-available` can be specified to select from any of the available hardware reservations. An error will be returned if the requested reservation option is not available. See [Reserved Hardware](https://deploy.equinix.com/developers/docs/metal/deploy/reserved/) for more details.", + "json_tag": "hardware_reservation_id" + }, + "Hostname": { + "name": "Hostname", + "description": "The hostname to use within the operating system. The same hostname may be used on multiple devices within a project.", + "json_tag": "hostname" + }, + "IpAddresses": { + "name": "IpAddresses", + "description": "The `ip_addresses attribute will allow you to specify the addresses you want created with your device. The default value configures public IPv4, public IPv6, and private IPv4. Private IPv4 address is required. When specifying `ip_addresses`, one of the array items must enable private IPv4. Some operating systems require public IPv4 address. In those cases you will receive an error message if public IPv4 is not enabled. For example, to only configure your server with a private IPv4 address, you can send `{ \\\"ip_addresses\\\": [{ \\\"address_family\\\": 4, \\\"public\\\": false }] }`. It is possible to request a subnet size larger than a `/30` by assigning addresses using the UUID(s) of ip_reservations in your project. For example, `{ \\\"ip_addresses\\\": [..., {\\\"address_family\\\": 4, \\\"public\\\": true, \\\"ip_reservations\\\": [\\\"uuid1\\\", \\\"uuid2\\\"]}] }` To access a server without public IPs, you can use our Out-of-Band console access (SOS) or proxy through another server in the project with public IPs enabled.", + "json_tag": "ip_addresses" + }, + "IpxeScriptUrl": { + "name": "IpxeScriptUrl", + "description": "When set, the device will chainload an iPXE Script at boot fetched from the supplied URL. See [Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/) for more details.", + "json_tag": "ipxe_script_url" + }, + "Locked": { + "name": "Locked", + "description": "Whether the device should be locked, preventing accidental deletion.", + "json_tag": "locked" + }, + "NetworkFrozen": { + "name": "NetworkFrozen", + "description": "If true, this instance can not be converted to a different network type.", + "json_tag": "network_frozen" + }, + "NoSshKeys": { + "name": "NoSshKeys", + "description": "Overrides default behaviour of attaching all of the organization members ssh keys and project ssh keys to device if no specific keys specified", + "json_tag": "no_ssh_keys" + }, + "OperatingSystem": { + "name": "OperatingSystem", + "description": "The slug of the operating system to provision. Check the Equinix Metal operating system documentation for rules that may be imposed per operating system, including restrictions on IP address options and device plans.", + "json_tag": "operating_system" + }, + "Plan": { + "name": "Plan", + "description": "The slug of the device plan to provision.", + "json_tag": "plan" + }, + "PrivateIpv4SubnetSize": { + "name": "PrivateIpv4SubnetSize", + "description": "Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device.", + "json_tag": "private_ipv4_subnet_size" + }, + "ProjectSshKeys": { + "name": "ProjectSshKeys", + "description": "A list of UUIDs identifying the device parent project that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. If no SSH keys are specified (`user_ssh_keys`, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added.", + "json_tag": "project_ssh_keys" + }, + "PublicIpv4SubnetSize": { + "name": "PublicIpv4SubnetSize", + "description": "Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device. Your project must have addresses available for a non-default request.", + "json_tag": "public_ipv4_subnet_size" + }, + "SpotInstance": { + "name": "SpotInstance", + "description": "Create a spot instance. Spot instances are created with a maximum bid price. If the bid price is not met, the spot instance will be terminated as indicated by the `termination_time` field.", + "json_tag": "spot_instance" + }, + "SpotPriceMax": { + "name": "SpotPriceMax", + "description": "The maximum amount to bid for a spot instance.", + "json_tag": "spot_price_max" + }, + "SshKeys": { + "name": "SshKeys", + "description": "A list of new or existing project ssh_keys that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. These keys are added in addition to any keys defined by `project_ssh_keys` and `user_ssh_keys`.", + "json_tag": "ssh_keys" + }, + "Storage": { + "name": "Storage", + "description": "", + "json_tag": "storage" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "TerminationTime": { + "name": "TerminationTime", + "description": "When the device will be terminated. If you don't supply timezone info, the timestamp is assumed to be in UTC. This is commonly set in advance for ephemeral spot market instances but this field may also be set with on-demand and reservation instances to automatically delete the resource at a given time. The termination time can also be used to release a hardware reservation instance at a given time, keeping the reservation open for other uses. On a spot market device, the termination time will be set automatically when outbid.", + "json_tag": "termination_time" + }, + "UserSshKeys": { + "name": "UserSshKeys", + "description": "A list of UUIDs identifying the users that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. The users must be members of the project or organization. If no SSH keys are specified (`user_ssh_keys`, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added.", + "json_tag": "user_ssh_keys" + }, + "Userdata": { + "name": "Userdata", + "description": "The userdata presented in the metadata service for this device. Userdata is fetched and interpreted by the operating system installed on the device. Acceptable formats are determined by the operating system, with the exception of a special iPXE enabling syntax which is handled before the operating system starts. See [Server User Data](https://deploy.equinix.com/developers/docs/metal/server-metadata/user-data/) and [Provisioning with Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/#provisioning-with-custom-ipxe) for more details.", + "json_tag": "userdata" + } + } + }, + "DeviceCreateInMetroInput": { + "type_name": "DeviceCreateInMetroInput", + "description": "DeviceCreateInMetroInput struct for DeviceCreateInMetroInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AlwaysPxe": { + "name": "AlwaysPxe", + "description": "When true, devices with a `custom_ipxe` OS will always boot to iPXE. The default setting of false ensures that iPXE will be used on only the first boot.", + "json_tag": "always_pxe" + }, + "BillingCycle": { + "name": "BillingCycle", + "description": "", + "json_tag": "billing_cycle" + }, + "Customdata": { + "name": "Customdata", + "description": "Customdata is an arbitrary JSON value that can be accessed via the metadata service.", + "json_tag": "customdata" + }, + "Description": { + "name": "Description", + "description": "Any description of the device or how it will be used. This may be used to inform other API consumers with project access.", + "json_tag": "description" + }, + "Features": { + "name": "Features", + "description": "The features attribute allows you to optionally specify what features your server should have. In the API shorthand syntax, all features listed are `required`: ``` { \\\"features\\\": [\\\"tpm\\\"] } ``` Alternatively, if you do not require a certain feature, but would prefer to be assigned a server with that feature if there are any available, you may specify that feature with a `preferred` value. The request will not fail if we have no servers with that feature in our inventory. The API offers an alternative syntax for mixing preferred and required features: ``` { \\\"features\\\": { \\\"tpm\\\": \\\"required\\\", \\\"raid\\\": \\\"preferred\\\" } } ``` The request will only fail if there are no available servers matching the required `tpm` criteria.", + "json_tag": "features" + }, + "HardwareReservationId": { + "name": "HardwareReservationId", + "description": "The Hardware Reservation UUID to provision. Alternatively, `next-available` can be specified to select from any of the available hardware reservations. An error will be returned if the requested reservation option is not available. See [Reserved Hardware](https://deploy.equinix.com/developers/docs/metal/deploy/reserved/) for more details.", + "json_tag": "hardware_reservation_id" + }, + "Hostname": { + "name": "Hostname", + "description": "The hostname to use within the operating system. The same hostname may be used on multiple devices within a project.", + "json_tag": "hostname" + }, + "IpAddresses": { + "name": "IpAddresses", + "description": "The `ip_addresses attribute will allow you to specify the addresses you want created with your device. The default value configures public IPv4, public IPv6, and private IPv4. Private IPv4 address is required. When specifying `ip_addresses`, one of the array items must enable private IPv4. Some operating systems require public IPv4 address. In those cases you will receive an error message if public IPv4 is not enabled. For example, to only configure your server with a private IPv4 address, you can send `{ \\\"ip_addresses\\\": [{ \\\"address_family\\\": 4, \\\"public\\\": false }] }`. It is possible to request a subnet size larger than a `/30` by assigning addresses using the UUID(s) of ip_reservations in your project. For example, `{ \\\"ip_addresses\\\": [..., {\\\"address_family\\\": 4, \\\"public\\\": true, \\\"ip_reservations\\\": [\\\"uuid1\\\", \\\"uuid2\\\"]}] }` To access a server without public IPs, you can use our Out-of-Band console access (SOS) or proxy through another server in the project with public IPs enabled.", + "json_tag": "ip_addresses" + }, + "IpxeScriptUrl": { + "name": "IpxeScriptUrl", + "description": "When set, the device will chainload an iPXE Script at boot fetched from the supplied URL. See [Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/) for more details.", + "json_tag": "ipxe_script_url" + }, + "Locked": { + "name": "Locked", + "description": "Whether the device should be locked, preventing accidental deletion.", + "json_tag": "locked" + }, + "Metro": { + "name": "Metro", + "description": "Metro code or ID of where the device should be provisioned in, or it can be instructed to create the device in the best available metro with `{ \\\"metro\\\": \\\"any\\\" }`. The special metro value of any means anywhere, any metro. When any is chosen in the request, the metro location is picked per our scheduling algorithms that favor the following factors: hardware reservation location (if requesting reserved hardware), ip reservations, spot instances, etc. The any keyword *does not* optimize for cost, this means that usage costs (instance, transfer, other features dependent on location) will vary. Please check metro value in response to see where the device was created. Either metro or facility must be provided.", + "json_tag": "metro" + }, + "NetworkFrozen": { + "name": "NetworkFrozen", + "description": "If true, this instance can not be converted to a different network type.", + "json_tag": "network_frozen" + }, + "NoSshKeys": { + "name": "NoSshKeys", + "description": "Overrides default behaviour of attaching all of the organization members ssh keys and project ssh keys to device if no specific keys specified", + "json_tag": "no_ssh_keys" + }, + "OperatingSystem": { + "name": "OperatingSystem", + "description": "The slug of the operating system to provision. Check the Equinix Metal operating system documentation for rules that may be imposed per operating system, including restrictions on IP address options and device plans.", + "json_tag": "operating_system" + }, + "Plan": { + "name": "Plan", + "description": "The slug of the device plan to provision.", + "json_tag": "plan" + }, + "PrivateIpv4SubnetSize": { + "name": "PrivateIpv4SubnetSize", + "description": "Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device.", + "json_tag": "private_ipv4_subnet_size" + }, + "ProjectSshKeys": { + "name": "ProjectSshKeys", + "description": "A list of UUIDs identifying the device parent project that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. If no SSH keys are specified (`user_ssh_keys`, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added.", + "json_tag": "project_ssh_keys" + }, + "PublicIpv4SubnetSize": { + "name": "PublicIpv4SubnetSize", + "description": "Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device. Your project must have addresses available for a non-default request.", + "json_tag": "public_ipv4_subnet_size" + }, + "SpotInstance": { + "name": "SpotInstance", + "description": "Create a spot instance. Spot instances are created with a maximum bid price. If the bid price is not met, the spot instance will be terminated as indicated by the `termination_time` field.", + "json_tag": "spot_instance" + }, + "SpotPriceMax": { + "name": "SpotPriceMax", + "description": "The maximum amount to bid for a spot instance.", + "json_tag": "spot_price_max" + }, + "SshKeys": { + "name": "SshKeys", + "description": "A list of new or existing project ssh_keys that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. These keys are added in addition to any keys defined by `project_ssh_keys` and `user_ssh_keys`.", + "json_tag": "ssh_keys" + }, + "Storage": { + "name": "Storage", + "description": "", + "json_tag": "storage" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "TerminationTime": { + "name": "TerminationTime", + "description": "When the device will be terminated. If you don't supply timezone info, the timestamp is assumed to be in UTC. This is commonly set in advance for ephemeral spot market instances but this field may also be set with on-demand and reservation instances to automatically delete the resource at a given time. The termination time can also be used to release a hardware reservation instance at a given time, keeping the reservation open for other uses. On a spot market device, the termination time will be set automatically when outbid.", + "json_tag": "termination_time" + }, + "UserSshKeys": { + "name": "UserSshKeys", + "description": "A list of UUIDs identifying the users that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. The users must be members of the project or organization. If no SSH keys are specified (`user_ssh_keys`, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added.", + "json_tag": "user_ssh_keys" + }, + "Userdata": { + "name": "Userdata", + "description": "The userdata presented in the metadata service for this device. Userdata is fetched and interpreted by the operating system installed on the device. Acceptable formats are determined by the operating system, with the exception of a special iPXE enabling syntax which is handled before the operating system starts. See [Server User Data](https://deploy.equinix.com/developers/docs/metal/server-metadata/user-data/) and [Provisioning with Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/#provisioning-with-custom-ipxe) for more details.", + "json_tag": "userdata" + } + } + }, + "DeviceCreateInput": { + "type_name": "DeviceCreateInput", + "description": "DeviceCreateInput struct for DeviceCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AlwaysPxe": { + "name": "AlwaysPxe", + "description": "When true, devices with a `custom_ipxe` OS will always boot to iPXE. The default setting of false ensures that iPXE will be used on only the first boot.", + "json_tag": "always_pxe" + }, + "BillingCycle": { + "name": "BillingCycle", + "description": "", + "json_tag": "billing_cycle" + }, + "Customdata": { + "name": "Customdata", + "description": "Customdata is an arbitrary JSON value that can be accessed via the metadata service.", + "json_tag": "customdata" + }, + "Description": { + "name": "Description", + "description": "Any description of the device or how it will be used. This may be used to inform other API consumers with project access.", + "json_tag": "description" + }, + "Features": { + "name": "Features", + "description": "The features attribute allows you to optionally specify what features your server should have. In the API shorthand syntax, all features listed are `required`: ``` { \\\"features\\\": [\\\"tpm\\\"] } ``` Alternatively, if you do not require a certain feature, but would prefer to be assigned a server with that feature if there are any available, you may specify that feature with a `preferred` value. The request will not fail if we have no servers with that feature in our inventory. The API offers an alternative syntax for mixing preferred and required features: ``` { \\\"features\\\": { \\\"tpm\\\": \\\"required\\\", \\\"raid\\\": \\\"preferred\\\" } } ``` The request will only fail if there are no available servers matching the required `tpm` criteria.", + "json_tag": "features" + }, + "HardwareReservationId": { + "name": "HardwareReservationId", + "description": "The Hardware Reservation UUID to provision. Alternatively, `next-available` can be specified to select from any of the available hardware reservations. An error will be returned if the requested reservation option is not available. See [Reserved Hardware](https://deploy.equinix.com/developers/docs/metal/deploy/reserved/) for more details.", + "json_tag": "hardware_reservation_id" + }, + "Hostname": { + "name": "Hostname", + "description": "The hostname to use within the operating system. The same hostname may be used on multiple devices within a project.", + "json_tag": "hostname" + }, + "IpAddresses": { + "name": "IpAddresses", + "description": "The `ip_addresses attribute will allow you to specify the addresses you want created with your device. The default value configures public IPv4, public IPv6, and private IPv4. Private IPv4 address is required. When specifying `ip_addresses`, one of the array items must enable private IPv4. Some operating systems require public IPv4 address. In those cases you will receive an error message if public IPv4 is not enabled. For example, to only configure your server with a private IPv4 address, you can send `{ \\\"ip_addresses\\\": [{ \\\"address_family\\\": 4, \\\"public\\\": false }] }`. It is possible to request a subnet size larger than a `/30` by assigning addresses using the UUID(s) of ip_reservations in your project. For example, `{ \\\"ip_addresses\\\": [..., {\\\"address_family\\\": 4, \\\"public\\\": true, \\\"ip_reservations\\\": [\\\"uuid1\\\", \\\"uuid2\\\"]}] }` To access a server without public IPs, you can use our Out-of-Band console access (SOS) or proxy through another server in the project with public IPs enabled.", + "json_tag": "ip_addresses" + }, + "IpxeScriptUrl": { + "name": "IpxeScriptUrl", + "description": "When set, the device will chainload an iPXE Script at boot fetched from the supplied URL. See [Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/) for more details.", + "json_tag": "ipxe_script_url" + }, + "Locked": { + "name": "Locked", + "description": "Whether the device should be locked, preventing accidental deletion.", + "json_tag": "locked" + }, + "NetworkFrozen": { + "name": "NetworkFrozen", + "description": "If true, this instance can not be converted to a different network type.", + "json_tag": "network_frozen" + }, + "NoSshKeys": { + "name": "NoSshKeys", + "description": "Overrides default behaviour of attaching all of the organization members ssh keys and project ssh keys to device if no specific keys specified", + "json_tag": "no_ssh_keys" + }, + "OperatingSystem": { + "name": "OperatingSystem", + "description": "The slug of the operating system to provision. Check the Equinix Metal operating system documentation for rules that may be imposed per operating system, including restrictions on IP address options and device plans.", + "json_tag": "operating_system" + }, + "Plan": { + "name": "Plan", + "description": "The slug of the device plan to provision.", + "json_tag": "plan" + }, + "PrivateIpv4SubnetSize": { + "name": "PrivateIpv4SubnetSize", + "description": "Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device.", + "json_tag": "private_ipv4_subnet_size" + }, + "ProjectSshKeys": { + "name": "ProjectSshKeys", + "description": "A list of UUIDs identifying the device parent project that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. If no SSH keys are specified (`user_ssh_keys`, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added.", + "json_tag": "project_ssh_keys" + }, + "PublicIpv4SubnetSize": { + "name": "PublicIpv4SubnetSize", + "description": "Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device. Your project must have addresses available for a non-default request.", + "json_tag": "public_ipv4_subnet_size" + }, + "SpotInstance": { + "name": "SpotInstance", + "description": "Create a spot instance. Spot instances are created with a maximum bid price. If the bid price is not met, the spot instance will be terminated as indicated by the `termination_time` field.", + "json_tag": "spot_instance" + }, + "SpotPriceMax": { + "name": "SpotPriceMax", + "description": "The maximum amount to bid for a spot instance.", + "json_tag": "spot_price_max" + }, + "SshKeys": { + "name": "SshKeys", + "description": "A list of new or existing project ssh_keys that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. These keys are added in addition to any keys defined by `project_ssh_keys` and `user_ssh_keys`.", + "json_tag": "ssh_keys" + }, + "Storage": { + "name": "Storage", + "description": "", + "json_tag": "storage" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "TerminationTime": { + "name": "TerminationTime", + "description": "When the device will be terminated. If you don't supply timezone info, the timestamp is assumed to be in UTC. This is commonly set in advance for ephemeral spot market instances but this field may also be set with on-demand and reservation instances to automatically delete the resource at a given time. The termination time can also be used to release a hardware reservation instance at a given time, keeping the reservation open for other uses. On a spot market device, the termination time will be set automatically when outbid.", + "json_tag": "termination_time" + }, + "UserSshKeys": { + "name": "UserSshKeys", + "description": "A list of UUIDs identifying the users that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. The users must be members of the project or organization. If no SSH keys are specified (`user_ssh_keys`, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added.", + "json_tag": "user_ssh_keys" + }, + "Userdata": { + "name": "Userdata", + "description": "The userdata presented in the metadata service for this device. Userdata is fetched and interpreted by the operating system installed on the device. Acceptable formats are determined by the operating system, with the exception of a special iPXE enabling syntax which is handled before the operating system starts. See [Server User Data](https://deploy.equinix.com/developers/docs/metal/server-metadata/user-data/) and [Provisioning with Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/#provisioning-with-custom-ipxe) for more details.", + "json_tag": "userdata" + } + } + }, + "DeviceCreatedBy": { + "type_name": "DeviceCreatedBy", + "description": "DeviceCreatedBy struct for DeviceCreatedBy", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AvatarThumbUrl": { + "name": "AvatarThumbUrl", + "description": "Avatar thumbnail URL of the User", + "json_tag": "avatar_thumb_url" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "When the user was created", + "json_tag": "created_at" + }, + "Email": { + "name": "Email", + "description": "Primary email address of the User", + "json_tag": "email" + }, + "FirstName": { + "name": "FirstName", + "description": "First name of the User", + "json_tag": "first_name" + }, + "FullName": { + "name": "FullName", + "description": "Full name of the User", + "json_tag": "full_name" + }, + "Href": { + "name": "Href", + "description": "API URL uniquely representing the User", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "ID of the User", + "json_tag": "id" + }, + "LastName": { + "name": "LastName", + "description": "Last name of the User", + "json_tag": "last_name" + }, + "ShortId": { + "name": "ShortId", + "description": "Short ID of the User", + "json_tag": "short_id" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "When the user details were last updated", + "json_tag": "updated_at" + } + } + }, + "DeviceHealthRollup": { + "type_name": "DeviceHealthRollup", + "description": "DeviceHealthRollup Represents a Device Health Status", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "HealthRollup": { + "name": "HealthRollup", + "description": "", + "json_tag": "health_rollup" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "Last update of health status.", + "json_tag": "updated_at" + } + } + }, + "DeviceList": { + "type_name": "DeviceList", + "description": "DeviceList struct for DeviceList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Devices": { + "name": "Devices", + "description": "", + "json_tag": "devices" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + } + } + }, + "DeviceMetro": { + "type_name": "DeviceMetro", + "description": "DeviceMetro struct for DeviceMetro", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Country": { + "name": "Country", + "description": "", + "json_tag": "country" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "DeviceProjectLite": { + "type_name": "DeviceProjectLite", + "description": "DeviceProjectLite struct for DeviceProjectLite", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + } + } + }, + "DeviceUpdateInput": { + "type_name": "DeviceUpdateInput", + "description": "DeviceUpdateInput struct for DeviceUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AlwaysPxe": { + "name": "AlwaysPxe", + "description": "", + "json_tag": "always_pxe" + }, + "BillingCycle": { + "name": "BillingCycle", + "description": "", + "json_tag": "billing_cycle" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "FirmwareSetId": { + "name": "FirmwareSetId", + "description": "", + "json_tag": "firmware_set_id" + }, + "Hostname": { + "name": "Hostname", + "description": "", + "json_tag": "hostname" + }, + "IpxeScriptUrl": { + "name": "IpxeScriptUrl", + "description": "", + "json_tag": "ipxe_script_url" + }, + "Locked": { + "name": "Locked", + "description": "Whether the device should be locked, preventing accidental deletion.", + "json_tag": "locked" + }, + "NetworkFrozen": { + "name": "NetworkFrozen", + "description": "If true, this instance can not be converted to a different network type.", + "json_tag": "network_frozen" + }, + "SpotInstance": { + "name": "SpotInstance", + "description": "Can be set to false to convert a spot-market instance to on-demand.", + "json_tag": "spot_instance" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Userdata": { + "name": "Userdata", + "description": "", + "json_tag": "userdata" + } + } + }, + "DeviceUsage": { + "type_name": "DeviceUsage", + "description": "DeviceUsage struct for DeviceUsage", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Quantity": { + "name": "Quantity", + "description": "", + "json_tag": "quantity" + }, + "Total": { + "name": "Total", + "description": "", + "json_tag": "total" + }, + "Unit": { + "name": "Unit", + "description": "", + "json_tag": "unit" + } + } + }, + "DeviceUsageList": { + "type_name": "DeviceUsageList", + "description": "DeviceUsageList struct for DeviceUsageList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Usages": { + "name": "Usages", + "description": "", + "json_tag": "usages" + } + } + }, + "Disk": { + "type_name": "Disk", + "description": "Disk struct for Disk", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Device": { + "name": "Device", + "description": "", + "json_tag": "device" + }, + "Partitions": { + "name": "Partitions", + "description": "", + "json_tag": "partitions" + }, + "WipeTable": { + "name": "WipeTable", + "description": "", + "json_tag": "wipeTable" + } + } + }, + "Email": { + "type_name": "Email", + "description": "Email struct for Email", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + }, + "Default": { + "name": "Default", + "description": "", + "json_tag": "default" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Verified": { + "name": "Verified", + "description": "", + "json_tag": "verified" + } + } + }, + "EmailInput": { + "type_name": "EmailInput", + "description": "EmailInput struct for EmailInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + }, + "Default": { + "name": "Default", + "description": "", + "json_tag": "default" + } + } + }, + "Entitlement": { + "type_name": "Entitlement", + "description": "Entitlement struct for Entitlement", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "FeatureAccess": { + "name": "FeatureAccess", + "description": "", + "json_tag": "feature_access" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "InstanceQuota": { + "name": "InstanceQuota", + "description": "", + "json_tag": "instance_quota" + }, + "IpQuota": { + "name": "IpQuota", + "description": "", + "json_tag": "ip_quota" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "ProjectQuota": { + "name": "ProjectQuota", + "description": "", + "json_tag": "project_quota" + }, + "Slug": { + "name": "Slug", + "description": "", + "json_tag": "slug" + }, + "VolumeLimits": { + "name": "VolumeLimits", + "description": "", + "json_tag": "volume_limits" + }, + "VolumeQuota": { + "name": "VolumeQuota", + "description": "", + "json_tag": "volume_quota" + }, + "Weight": { + "name": "Weight", + "description": "", + "json_tag": "weight" + } + } + }, + "Error": { + "type_name": "Error", + "description": "Error Error responses are included with 4xx and 5xx HTTP responses from the API service. Either \\\"error\\\" or \\\"errors\\\" will be set.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Error": { + "name": "Error", + "description": "A description of the error that caused the request to fail.", + "json_tag": "error" + }, + "Errors": { + "name": "Errors", + "description": "A list of errors that contributed to the request failing.", + "json_tag": "errors" + } + } + }, + "Event": { + "type_name": "Event", + "description": "Event struct for Event", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Body": { + "name": "Body", + "description": "", + "json_tag": "body" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Interpolated": { + "name": "Interpolated", + "description": "", + "json_tag": "interpolated" + }, + "Ip": { + "name": "Ip", + "description": "", + "json_tag": "ip" + }, + "ModifiedBy": { + "name": "ModifiedBy", + "description": "", + "json_tag": "modified_by" + }, + "Relationships": { + "name": "Relationships", + "description": "", + "json_tag": "relationships" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "EventList": { + "type_name": "EventList", + "description": "EventList struct for EventList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Events": { + "name": "Events", + "description": "", + "json_tag": "events" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + } + } + }, + "FabricServiceToken": { + "type_name": "FabricServiceToken", + "description": "FabricServiceToken struct for FabricServiceToken", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ExpiresAt": { + "name": "ExpiresAt", + "description": "The expiration date and time of the Fabric service token. Once a service token is expired, it is no longer redeemable.", + "json_tag": "expires_at" + }, + "Id": { + "name": "Id", + "description": "The UUID that can be used on the Fabric Portal to redeem either an A-Side or Z-Side Service Token. For Fabric VCs (Metal Billed), this UUID will represent an A-Side Service Token, which will allow interconnections to be made from Equinix Metal to other Service Providers on Fabric. For Fabric VCs (Fabric Billed), this UUID will represent a Z-Side Service Token, which will allow interconnections to be made to connect an owned Fabric Port or Virtual Device to Equinix Metal.", + "json_tag": "id" + }, + "MaxAllowedSpeed": { + "name": "MaxAllowedSpeed", + "description": "The maximum speed that can be selected on the Fabric Portal when configuring a interconnection with either an A-Side or Z-Side Service Token. For Fabric VCs (Metal Billed), this is what the billing is based off of, and can be one of the following options, '50mbps', '200mbps', '500mbps', '1gbps', '2gbps', '5gbps' or '10gbps'. For Fabric VCs (Fabric Billed), this will default to 10Gbps.", + "json_tag": "max_allowed_speed" + }, + "Role": { + "name": "Role", + "description": "", + "json_tag": "role" + }, + "ServiceTokenType": { + "name": "ServiceTokenType", + "description": "", + "json_tag": "service_token_type" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + } + } + }, + "Facility": { + "type_name": "Facility", + "description": "Facility struct for Facility", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Features": { + "name": "Features", + "description": "", + "json_tag": "features" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "IpRanges": { + "name": "IpRanges", + "description": "IP ranges registered in facility. Can be used for GeoIP location", + "json_tag": "ip_ranges" + }, + "Metro": { + "name": "Metro", + "description": "", + "json_tag": "metro" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "FacilityInput": { + "type_name": "FacilityInput", + "description": "FacilityInput struct for FacilityInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Facility": { + "name": "Facility", + "description": "The datacenter where the device should be created. Either metro or facility must be provided. The API will accept either a single facility `{ \\\"facility\\\": \\\"f1\\\" }`, or it can be instructed to create the device in the best available datacenter `{ \\\"facility\\\": \\\"any\\\" }`. Additionally it is possible to set a prioritized location selection. For example `{ \\\"facility\\\": [\\\"f3\\\", \\\"f2\\\", \\\"any\\\"] }` can be used to prioritize `f3` and then `f2` before accepting `any` facility. If none of the facilities provided have availability for the requested device the request will fail.\nDeprecated", + "json_tag": "facility" + } + } + }, + "FacilityList": { + "type_name": "FacilityList", + "description": "FacilityList struct for FacilityList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Facilities": { + "name": "Facilities", + "description": "", + "json_tag": "facilities" + } + } + }, + "Filesystem": { + "type_name": "Filesystem", + "description": "Filesystem struct for Filesystem", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Mount": { + "name": "Mount", + "description": "", + "json_tag": "mount" + } + } + }, + "FindIPAddressById200Response": { + "type_name": "FindIPAddressById200Response", + "description": "FindIPAddressById200Response - struct for FindIPAddressById200Response", + "fields": { + "IPAssignment": { + "name": "IPAssignment", + "description": "" + }, + "IPReservation": { + "name": "IPReservation", + "description": "" + }, + "VrfIpReservation": { + "name": "VrfIpReservation", + "description": "" + } + } + }, + "FindMetalGatewayById200Response": { + "type_name": "FindMetalGatewayById200Response", + "description": "FindMetalGatewayById200Response - struct for FindMetalGatewayById200Response", + "fields": { + "MetalGateway": { + "name": "MetalGateway", + "description": "" + }, + "VrfMetalGateway": { + "name": "VrfMetalGateway", + "description": "" + } + } + }, + "FindTrafficTimeframeParameter": { + "type_name": "FindTrafficTimeframeParameter", + "description": "FindTrafficTimeframeParameter struct for FindTrafficTimeframeParameter", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "EndedAt": { + "name": "EndedAt", + "description": "", + "json_tag": "ended_at" + }, + "StartedAt": { + "name": "StartedAt", + "description": "", + "json_tag": "started_at" + } + } + }, + "FirmwareSet": { + "type_name": "FirmwareSet", + "description": "FirmwareSet Represents a Firmware Set", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attributes": { + "name": "Attributes", + "description": "Represents a list of attributes", + "json_tag": "attributes" + }, + "ComponentFirmware": { + "name": "ComponentFirmware", + "description": "List of components versions", + "json_tag": "component_firmware" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "Datetime when the block was created.", + "json_tag": "created_at" + }, + "Name": { + "name": "Name", + "description": "Firmware Set Name", + "json_tag": "name" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "Datetime when the block was updated.", + "json_tag": "updated_at" + }, + "Uuid": { + "name": "Uuid", + "description": "Firmware Set UUID", + "json_tag": "uuid" + } + } + }, + "FirmwareSetListResponse": { + "type_name": "FirmwareSetListResponse", + "description": "FirmwareSetListResponse Represents collection of Firmware Sets", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Page": { + "name": "Page", + "description": "Page returned", + "json_tag": "page" + }, + "PageCount": { + "name": "PageCount", + "description": "Items returned in current page", + "json_tag": "page_count" + }, + "PageSize": { + "name": "PageSize", + "description": "Max number of items returned in a page", + "json_tag": "page_size" + }, + "Records": { + "name": "Records", + "description": "Represents a list of FirmwareSets", + "json_tag": "records" + }, + "TotalPages": { + "name": "TotalPages", + "description": "Total count of pages", + "json_tag": "total_pages" + }, + "TotalRecordCount": { + "name": "TotalRecordCount", + "description": "Total count of items", + "json_tag": "total_record_count" + } + } + }, + "FirmwareSetResponse": { + "type_name": "FirmwareSetResponse", + "description": "FirmwareSetResponse Represents single Firmware set response", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Record": { + "name": "Record", + "description": "", + "json_tag": "record" + } + } + }, + "GenericOpenAPIError": { + "type_name": "GenericOpenAPIError", + "description": "GenericOpenAPIError Provides access to the body, error and model on returned errors.", + "fields": { + "body": { + "name": "body", + "description": "" + }, + "error": { + "name": "error", + "description": "" + }, + "model": { + "name": "model", + "description": "" + } + } + }, + "GlobalBgpRange": { + "type_name": "GlobalBgpRange", + "description": "GlobalBgpRange struct for GlobalBgpRange", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AddressFamily": { + "name": "AddressFamily", + "description": "", + "json_tag": "address_family" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Range": { + "name": "Range", + "description": "", + "json_tag": "range" + } + } + }, + "GlobalBgpRangeList": { + "type_name": "GlobalBgpRangeList", + "description": "GlobalBgpRangeList struct for GlobalBgpRangeList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "GlobalBgpRanges": { + "name": "GlobalBgpRanges", + "description": "", + "json_tag": "global_bgp_ranges" + } + } + }, + "HardwareReservation": { + "type_name": "HardwareReservation", + "description": "HardwareReservation struct for HardwareReservation", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "CustomRate": { + "name": "CustomRate", + "description": "Amount that will be charged for every billing_cycle.", + "json_tag": "custom_rate" + }, + "Device": { + "name": "Device", + "description": "", + "json_tag": "device" + }, + "Facility": { + "name": "Facility", + "description": "", + "json_tag": "facility" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "NeedOfService": { + "name": "NeedOfService", + "description": "Whether this Device requires assistance from Equinix Metal.", + "json_tag": "need_of_service" + }, + "Plan": { + "name": "Plan", + "description": "", + "json_tag": "plan" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Provisionable": { + "name": "Provisionable", + "description": "Whether the reserved server is provisionable or not. Spare devices can't be provisioned unless they are activated first.", + "json_tag": "provisionable" + }, + "ShortId": { + "name": "ShortId", + "description": "Short version of the ID.", + "json_tag": "short_id" + }, + "Spare": { + "name": "Spare", + "description": "Whether the Hardware Reservation is a spare. Spare Hardware Reservations are used when a Hardware Reservations requires service from Equinix Metal", + "json_tag": "spare" + }, + "SwitchUuid": { + "name": "SwitchUuid", + "description": "Switch short id. This can be used to determine if two devices are connected to the same switch, for example.", + "json_tag": "switch_uuid" + }, + "TerminationTime": { + "name": "TerminationTime", + "description": "Expiration date for the reservation.", + "json_tag": "termination_time" + } + } + }, + "HardwareReservationList": { + "type_name": "HardwareReservationList", + "description": "HardwareReservationList struct for HardwareReservationList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "HardwareReservations": { + "name": "HardwareReservations", + "description": "", + "json_tag": "hardware_reservations" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + } + } + }, + "Href": { + "type_name": "Href", + "description": "Href struct for Href", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + } + } + }, + "IPAddress": { + "type_name": "IPAddress", + "description": "IPAddress struct for IPAddress", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AddressFamily": { + "name": "AddressFamily", + "description": "", + "json_tag": "address_family" + }, + "Cidr": { + "name": "Cidr", + "description": "Cidr Size for the IP Block created. Valid values depends on the operating system being provisioned. (28..32 for IPv4 addresses, 124..127 for IPv6 addresses)", + "json_tag": "cidr" + }, + "IpReservations": { + "name": "IpReservations", + "description": "UUIDs of any IP reservations to use when assigning IPs", + "json_tag": "ip_reservations" + }, + "Public": { + "name": "Public", + "description": "Address Type for IP Address", + "json_tag": "public" + } + } + }, + "IPAssignment": { + "type_name": "IPAssignment", + "description": "IPAssignment struct for IPAssignment", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + }, + "AddressFamily": { + "name": "AddressFamily", + "description": "", + "json_tag": "address_family" + }, + "AssignedTo": { + "name": "AssignedTo", + "description": "", + "json_tag": "assigned_to" + }, + "Cidr": { + "name": "Cidr", + "description": "", + "json_tag": "cidr" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Enabled": { + "name": "Enabled", + "description": "", + "json_tag": "enabled" + }, + "Gateway": { + "name": "Gateway", + "description": "", + "json_tag": "gateway" + }, + "GlobalIp": { + "name": "GlobalIp", + "description": "", + "json_tag": "global_ip" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Manageable": { + "name": "Manageable", + "description": "", + "json_tag": "manageable" + }, + "Management": { + "name": "Management", + "description": "", + "json_tag": "management" + }, + "Metro": { + "name": "Metro", + "description": "", + "json_tag": "metro" + }, + "Netmask": { + "name": "Netmask", + "description": "", + "json_tag": "netmask" + }, + "Network": { + "name": "Network", + "description": "", + "json_tag": "network" + }, + "NextHop": { + "name": "NextHop", + "description": "Only set when this is a Metal Gateway Elastic IP Assignment. The IP address within the Metal Gateway to which requests to the Elastic IP are forwarded.", + "json_tag": "next_hop" + }, + "ParentBlock": { + "name": "ParentBlock", + "description": "", + "json_tag": "parent_block" + }, + "Public": { + "name": "Public", + "description": "", + "json_tag": "public" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "IPAssignmentInput": { + "type_name": "IPAssignmentInput", + "description": "IPAssignmentInput struct for IPAssignmentInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + } + } + }, + "IPAssignmentList": { + "type_name": "IPAssignmentList", + "description": "IPAssignmentList struct for IPAssignmentList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "IpAddresses": { + "name": "IpAddresses", + "description": "", + "json_tag": "ip_addresses" + } + } + }, + "IPAssignmentMetro": { + "type_name": "IPAssignmentMetro", + "description": "IPAssignmentMetro struct for IPAssignmentMetro", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Country": { + "name": "Country", + "description": "", + "json_tag": "country" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "IPAssignmentUpdateInput": { + "type_name": "IPAssignmentUpdateInput", + "description": "IPAssignmentUpdateInput struct for IPAssignmentUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "IPAvailabilitiesList": { + "type_name": "IPAvailabilitiesList", + "description": "IPAvailabilitiesList struct for IPAvailabilitiesList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Available": { + "name": "Available", + "description": "", + "json_tag": "available" + } + } + }, + "IPReservation": { + "type_name": "IPReservation", + "description": "IPReservation struct for IPReservation", + "fields": { + "Addon": { + "name": "Addon", + "description": "", + "json_tag": "addon" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + }, + "AddressFamily": { + "name": "AddressFamily", + "description": "", + "json_tag": "address_family" + }, + "Assignments": { + "name": "Assignments", + "description": "", + "json_tag": "assignments" + }, + "Available": { + "name": "Available", + "description": "", + "json_tag": "available" + }, + "Bill": { + "name": "Bill", + "description": "", + "json_tag": "bill" + }, + "Cidr": { + "name": "Cidr", + "description": "", + "json_tag": "cidr" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "Enabled": { + "name": "Enabled", + "description": "", + "json_tag": "enabled" + }, + "Facility": { + "name": "Facility", + "description": "", + "json_tag": "facility" + }, + "Gateway": { + "name": "Gateway", + "description": "", + "json_tag": "gateway" + }, + "GlobalIp": { + "name": "GlobalIp", + "description": "", + "json_tag": "global_ip" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Manageable": { + "name": "Manageable", + "description": "", + "json_tag": "manageable" + }, + "Management": { + "name": "Management", + "description": "", + "json_tag": "management" + }, + "MetalGateway": { + "name": "MetalGateway", + "description": "", + "json_tag": "metal_gateway" + }, + "Metro": { + "name": "Metro", + "description": "", + "json_tag": "metro" + }, + "Netmask": { + "name": "Netmask", + "description": "", + "json_tag": "netmask" + }, + "Network": { + "name": "Network", + "description": "", + "json_tag": "network" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "ProjectLite": { + "name": "ProjectLite", + "description": "", + "json_tag": "project_lite" + }, + "Public": { + "name": "Public", + "description": "", + "json_tag": "public" + }, + "RequestedBy": { + "name": "RequestedBy", + "description": "", + "json_tag": "requested_by" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "IPReservationFacility": { + "type_name": "IPReservationFacility", + "description": "IPReservationFacility struct for IPReservationFacility", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Features": { + "name": "Features", + "description": "", + "json_tag": "features" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "IpRanges": { + "name": "IpRanges", + "description": "IP ranges registered in facility. Can be used for GeoIP location", + "json_tag": "ip_ranges" + }, + "Metro": { + "name": "Metro", + "description": "", + "json_tag": "metro" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "IPReservationList": { + "type_name": "IPReservationList", + "description": "IPReservationList struct for IPReservationList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "IpAddresses": { + "name": "IpAddresses", + "description": "", + "json_tag": "ip_addresses" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + } + } + }, + "IPReservationListIpAddressesInner": { + "type_name": "IPReservationListIpAddressesInner", + "description": "IPReservationListIpAddressesInner struct for IPReservationListIpAddressesInner", + "fields": { + "IPReservation": { + "name": "IPReservation", + "description": "" + }, + "VrfIpReservation": { + "name": "VrfIpReservation", + "description": "" + } + } + }, + "IPReservationMetro": { + "type_name": "IPReservationMetro", + "description": "IPReservationMetro struct for IPReservationMetro", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Country": { + "name": "Country", + "description": "", + "json_tag": "country" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "IPReservationRequestInput": { + "type_name": "IPReservationRequestInput", + "description": "IPReservationRequestInput struct for IPReservationRequestInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Comments": { + "name": "Comments", + "description": "", + "json_tag": "comments" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "Facility": { + "name": "Facility", + "description": "", + "json_tag": "facility" + }, + "FailOnApprovalRequired": { + "name": "FailOnApprovalRequired", + "description": "", + "json_tag": "fail_on_approval_required" + }, + "Metro": { + "name": "Metro", + "description": "The code of the metro you are requesting the IP reservation in.", + "json_tag": "metro" + }, + "Quantity": { + "name": "Quantity", + "description": "", + "json_tag": "quantity" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "InstancesBatchCreateInput": { + "type_name": "InstancesBatchCreateInput", + "description": "InstancesBatchCreateInput struct for InstancesBatchCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Batches": { + "name": "Batches", + "description": "", + "json_tag": "batches" + } + } + }, + "InstancesBatchCreateInputBatchesInner": { + "type_name": "InstancesBatchCreateInputBatchesInner", + "description": "InstancesBatchCreateInputBatchesInner struct for InstancesBatchCreateInputBatchesInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AlwaysPxe": { + "name": "AlwaysPxe", + "description": "When true, devices with a `custom_ipxe` OS will always boot to iPXE. The default setting of false ensures that iPXE will be used on only the first boot.", + "json_tag": "always_pxe" + }, + "BillingCycle": { + "name": "BillingCycle", + "description": "", + "json_tag": "billing_cycle" + }, + "Customdata": { + "name": "Customdata", + "description": "Customdata is an arbitrary JSON value that can be accessed via the metadata service.", + "json_tag": "customdata" + }, + "Description": { + "name": "Description", + "description": "Any description of the device or how it will be used. This may be used to inform other API consumers with project access.", + "json_tag": "description" + }, + "Facility": { + "name": "Facility", + "description": "The datacenter where the device should be created. Either metro or facility must be provided. The API will accept either a single facility `{ \\\"facility\\\": \\\"f1\\\" }`, or it can be instructed to create the device in the best available datacenter `{ \\\"facility\\\": \\\"any\\\" }`. Additionally it is possible to set a prioritized location selection. For example `{ \\\"facility\\\": [\\\"f3\\\", \\\"f2\\\", \\\"any\\\"] }` can be used to prioritize `f3` and then `f2` before accepting `any` facility. If none of the facilities provided have availability for the requested device the request will fail.\nDeprecated", + "json_tag": "facility" + }, + "Features": { + "name": "Features", + "description": "The features attribute allows you to optionally specify what features your server should have. In the API shorthand syntax, all features listed are `required`: ``` { \\\"features\\\": [\\\"tpm\\\"] } ``` Alternatively, if you do not require a certain feature, but would prefer to be assigned a server with that feature if there are any available, you may specify that feature with a `preferred` value. The request will not fail if we have no servers with that feature in our inventory. The API offers an alternative syntax for mixing preferred and required features: ``` { \\\"features\\\": { \\\"tpm\\\": \\\"required\\\", \\\"raid\\\": \\\"preferred\\\" } } ``` The request will only fail if there are no available servers matching the required `tpm` criteria.", + "json_tag": "features" + }, + "HardwareReservationId": { + "name": "HardwareReservationId", + "description": "The Hardware Reservation UUID to provision. Alternatively, `next-available` can be specified to select from any of the available hardware reservations. An error will be returned if the requested reservation option is not available. See [Reserved Hardware](https://deploy.equinix.com/developers/docs/metal/deploy/reserved/) for more details.", + "json_tag": "hardware_reservation_id" + }, + "Hostname": { + "name": "Hostname", + "description": "The hostname to use within the operating system. The same hostname may be used on multiple devices within a project.", + "json_tag": "hostname" + }, + "Hostnames": { + "name": "Hostnames", + "description": "", + "json_tag": "hostnames" + }, + "IpAddresses": { + "name": "IpAddresses", + "description": "The `ip_addresses attribute will allow you to specify the addresses you want created with your device. The default value configures public IPv4, public IPv6, and private IPv4. Private IPv4 address is required. When specifying `ip_addresses`, one of the array items must enable private IPv4. Some operating systems require public IPv4 address. In those cases you will receive an error message if public IPv4 is not enabled. For example, to only configure your server with a private IPv4 address, you can send `{ \\\"ip_addresses\\\": [{ \\\"address_family\\\": 4, \\\"public\\\": false }] }`. It is possible to request a subnet size larger than a `/30` by assigning addresses using the UUID(s) of ip_reservations in your project. For example, `{ \\\"ip_addresses\\\": [..., {\\\"address_family\\\": 4, \\\"public\\\": true, \\\"ip_reservations\\\": [\\\"uuid1\\\", \\\"uuid2\\\"]}] }` To access a server without public IPs, you can use our Out-of-Band console access (SOS) or proxy through another server in the project with public IPs enabled.", + "json_tag": "ip_addresses" + }, + "IpxeScriptUrl": { + "name": "IpxeScriptUrl", + "description": "When set, the device will chainload an iPXE Script at boot fetched from the supplied URL. See [Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/) for more details.", + "json_tag": "ipxe_script_url" + }, + "Locked": { + "name": "Locked", + "description": "Whether the device should be locked, preventing accidental deletion.", + "json_tag": "locked" + }, + "Metro": { + "name": "Metro", + "description": "Metro code or ID of where the device should be provisioned in, or it can be instructed to create the device in the best available metro with `{ \\\"metro\\\": \\\"any\\\" }`. The special metro value of any means anywhere, any metro. When any is chosen in the request, the metro location is picked per our scheduling algorithms that favor the following factors: hardware reservation location (if requesting reserved hardware), ip reservations, spot instances, etc. The any keyword *does not* optimize for cost, this means that usage costs (instance, transfer, other features dependent on location) will vary. Please check metro value in response to see where the device was created. Either metro or facility must be provided.", + "json_tag": "metro" + }, + "NetworkFrozen": { + "name": "NetworkFrozen", + "description": "If true, this instance can not be converted to a different network type.", + "json_tag": "network_frozen" + }, + "NoSshKeys": { + "name": "NoSshKeys", + "description": "Overrides default behaviour of attaching all of the organization members ssh keys and project ssh keys to device if no specific keys specified", + "json_tag": "no_ssh_keys" + }, + "OperatingSystem": { + "name": "OperatingSystem", + "description": "The slug of the operating system to provision. Check the Equinix Metal operating system documentation for rules that may be imposed per operating system, including restrictions on IP address options and device plans.", + "json_tag": "operating_system" + }, + "Plan": { + "name": "Plan", + "description": "The slug of the device plan to provision.", + "json_tag": "plan" + }, + "PrivateIpv4SubnetSize": { + "name": "PrivateIpv4SubnetSize", + "description": "Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device.", + "json_tag": "private_ipv4_subnet_size" + }, + "ProjectSshKeys": { + "name": "ProjectSshKeys", + "description": "A list of UUIDs identifying the device parent project that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. If no SSH keys are specified (`user_ssh_keys`, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added.", + "json_tag": "project_ssh_keys" + }, + "PublicIpv4SubnetSize": { + "name": "PublicIpv4SubnetSize", + "description": "Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device. Your project must have addresses available for a non-default request.", + "json_tag": "public_ipv4_subnet_size" + }, + "Quantity": { + "name": "Quantity", + "description": "The number of devices to create in this batch. The hostname may contain an `{{index}}` placeholder, which will be replaced with the index of the device in the batch. For example, if the hostname is `device-{{index}}`, the first device in the batch will have the hostname `device-01`, the second device will have the hostname `device-02`, and so on.", + "json_tag": "quantity" + }, + "SpotInstance": { + "name": "SpotInstance", + "description": "Create a spot instance. Spot instances are created with a maximum bid price. If the bid price is not met, the spot instance will be terminated as indicated by the `termination_time` field.", + "json_tag": "spot_instance" + }, + "SpotPriceMax": { + "name": "SpotPriceMax", + "description": "The maximum amount to bid for a spot instance.", + "json_tag": "spot_price_max" + }, + "SshKeys": { + "name": "SshKeys", + "description": "A list of new or existing project ssh_keys that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. These keys are added in addition to any keys defined by `project_ssh_keys` and `user_ssh_keys`.", + "json_tag": "ssh_keys" + }, + "Storage": { + "name": "Storage", + "description": "", + "json_tag": "storage" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "TerminationTime": { + "name": "TerminationTime", + "description": "When the device will be terminated. If you don't supply timezone info, the timestamp is assumed to be in UTC. This is commonly set in advance for ephemeral spot market instances but this field may also be set with on-demand and reservation instances to automatically delete the resource at a given time. The termination time can also be used to release a hardware reservation instance at a given time, keeping the reservation open for other uses. On a spot market device, the termination time will be set automatically when outbid.", + "json_tag": "termination_time" + }, + "UserSshKeys": { + "name": "UserSshKeys", + "description": "A list of UUIDs identifying the users that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. The users must be members of the project or organization. If no SSH keys are specified (`user_ssh_keys`, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added.", + "json_tag": "user_ssh_keys" + }, + "Userdata": { + "name": "Userdata", + "description": "The userdata presented in the metadata service for this device. Userdata is fetched and interpreted by the operating system installed on the device. Acceptable formats are determined by the operating system, with the exception of a special iPXE enabling syntax which is handled before the operating system starts. See [Server User Data](https://deploy.equinix.com/developers/docs/metal/server-metadata/user-data/) and [Provisioning with Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/#provisioning-with-custom-ipxe) for more details.", + "json_tag": "userdata" + } + } + }, + "Interconnection": { + "type_name": "Interconnection", + "description": "Interconnection struct for Interconnection", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AuthorizationCode": { + "name": "AuthorizationCode", + "description": "For Fabric VCs (Metal Billed), this allows Fabric to connect the Metal network to any connection Fabric facilitates. Fabric uses this token to be able to give more detailed information about the Metal end of the network, when viewing resources from within Fabric.", + "json_tag": "authorization_code" + }, + "ContactEmail": { + "name": "ContactEmail", + "description": "", + "json_tag": "contact_email" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "FabricProvider": { + "name": "FabricProvider", + "description": "", + "json_tag": "fabric_provider" + }, + "Facility": { + "name": "Facility", + "description": "", + "json_tag": "facility" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Metro": { + "name": "Metro", + "description": "", + "json_tag": "metro" + }, + "Mode": { + "name": "Mode", + "description": "", + "json_tag": "mode" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Organization": { + "name": "Organization", + "description": "", + "json_tag": "organization" + }, + "Ports": { + "name": "Ports", + "description": "For Fabric VCs, these represent Virtual Port(s) created for the interconnection. For dedicated interconnections, these represent the Dedicated Port(s).", + "json_tag": "ports" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Redundancy": { + "name": "Redundancy", + "description": "", + "json_tag": "redundancy" + }, + "RequestedBy": { + "name": "RequestedBy", + "description": "", + "json_tag": "requested_by" + }, + "ServiceTokens": { + "name": "ServiceTokens", + "description": "For Fabric VCs (Metal Billed), this will show details of the A-Side service tokens issued for the interconnection. For Fabric VCs (Fabric Billed), this will show the details of the Z-Side service tokens issued for the interconnection. Dedicated interconnections will not have any service tokens issued. There will be one per interconnection, so for redundant interconnections, there should be two service tokens issued.", + "json_tag": "service_tokens" + }, + "Speed": { + "name": "Speed", + "description": "For interconnections on Dedicated Ports and shared connections, this represents the interconnection's speed in bps. For Fabric VCs, this field refers to the maximum speed of the interconnection in bps. This value will default to 10Gbps for Fabric VCs (Fabric Billed).", + "json_tag": "speed" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Token": { + "name": "Token", + "description": "This token is used for shared interconnections to be used as the Fabric Token. This field is entirely deprecated.", + "json_tag": "token" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + } + } + }, + "InterconnectionFabricProvider": { + "type_name": "InterconnectionFabricProvider", + "description": "InterconnectionFabricProvider - Configuration information for connecting to external cloud service provider. Only available if the fabric_provider param was used when creating the interconnection.", + "fields": { + "AWSFabricProvider": { + "name": "AWSFabricProvider", + "description": "" + } + } + }, + "InterconnectionList": { + "type_name": "InterconnectionList", + "description": "InterconnectionList struct for InterconnectionList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Interconnections": { + "name": "Interconnections", + "description": "", + "json_tag": "interconnections" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + } + } + }, + "InterconnectionMetroList": { + "type_name": "InterconnectionMetroList", + "description": "InterconnectionMetroList struct for InterconnectionMetroList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + }, + "Metros": { + "name": "Metros", + "description": "", + "json_tag": "metros" + } + } + }, + "InterconnectionMetroListMetrosInner": { + "type_name": "InterconnectionMetroListMetrosInner", + "description": "InterconnectionMetroListMetrosInner struct for InterconnectionMetroListMetrosInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Country": { + "name": "Country", + "description": "", + "json_tag": "country" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Providers": { + "name": "Providers", + "description": "A list of providers and their equivalent regions available for connecting to the provider network.", + "json_tag": "providers" + } + } + }, + "InterconnectionMetroListMetrosInnerAllOfProvidersInner": { + "type_name": "InterconnectionMetroListMetrosInnerAllOfProvidersInner", + "description": "InterconnectionMetroListMetrosInnerAllOfProvidersInner struct for InterconnectionMetroListMetrosInnerAllOfProvidersInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidths": { + "name": "Bandwidths", + "description": "", + "json_tag": "bandwidths" + }, + "Features": { + "name": "Features", + "description": "", + "json_tag": "features" + }, + "Locations": { + "name": "Locations", + "description": "", + "json_tag": "locations" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "InterconnectionPort": { + "type_name": "InterconnectionPort", + "description": "InterconnectionPort struct for InterconnectionPort", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "LinkStatus": { + "name": "LinkStatus", + "description": "", + "json_tag": "link_status" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Organization": { + "name": "Organization", + "description": "", + "json_tag": "organization" + }, + "Role": { + "name": "Role", + "description": "", + "json_tag": "role" + }, + "Speed": { + "name": "Speed", + "description": "", + "json_tag": "speed" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "SwitchId": { + "name": "SwitchId", + "description": "A switch 'short ID'", + "json_tag": "switch_id" + }, + "VirtualCircuits": { + "name": "VirtualCircuits", + "description": "", + "json_tag": "virtual_circuits" + } + } + }, + "InterconnectionPortList": { + "type_name": "InterconnectionPortList", + "description": "InterconnectionPortList struct for InterconnectionPortList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Ports": { + "name": "Ports", + "description": "", + "json_tag": "ports" + } + } + }, + "InterconnectionPricingList": { + "type_name": "InterconnectionPricingList", + "description": "InterconnectionPricingList struct for InterconnectionPricingList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ProviderPricing": { + "name": "ProviderPricing", + "description": "Pricing information per connection provider.", + "json_tag": "provider_pricing" + } + } + }, + "InterconnectionPricingListProviderPricingInner": { + "type_name": "InterconnectionPricingListProviderPricingInner", + "description": "InterconnectionPricingListProviderPricingInner struct for InterconnectionPricingListProviderPricingInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Provider": { + "name": "Provider", + "description": "", + "json_tag": "provider" + }, + "Tiers": { + "name": "Tiers", + "description": "", + "json_tag": "tiers" + } + } + }, + "InterconnectionPricingListProviderPricingInnerTiersInner": { + "type_name": "InterconnectionPricingListProviderPricingInnerTiersInner", + "description": "InterconnectionPricingListProviderPricingInnerTiersInner struct for InterconnectionPricingListProviderPricingInnerTiersInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bandwidth": { + "name": "Bandwidth", + "description": "Bandwidth tier in Mbps", + "json_tag": "bandwidth" + }, + "BillingCycle": { + "name": "BillingCycle", + "description": "", + "json_tag": "billing_cycle" + }, + "Price": { + "name": "Price", + "description": "", + "json_tag": "price" + } + } + }, + "InterconnectionUpdateInput": { + "type_name": "InterconnectionUpdateInput", + "description": "InterconnectionUpdateInput struct for InterconnectionUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ContactEmail": { + "name": "ContactEmail", + "description": "", + "json_tag": "contact_email" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Mode": { + "name": "Mode", + "description": "", + "json_tag": "mode" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "Invitation": { + "type_name": "Invitation", + "description": "Invitation struct for Invitation", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Invitation": { + "name": "Invitation", + "description": "", + "json_tag": "invitation" + }, + "InvitedBy": { + "name": "InvitedBy", + "description": "", + "json_tag": "invited_by" + }, + "Invitee": { + "name": "Invitee", + "description": "", + "json_tag": "invitee" + }, + "Nonce": { + "name": "Nonce", + "description": "", + "json_tag": "nonce" + }, + "Organization": { + "name": "Organization", + "description": "", + "json_tag": "organization" + }, + "Projects": { + "name": "Projects", + "description": "", + "json_tag": "projects" + }, + "Roles": { + "name": "Roles", + "description": "", + "json_tag": "roles" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + } + } + }, + "InvitationInput": { + "type_name": "InvitationInput", + "description": "InvitationInput struct for InvitationInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Invitee": { + "name": "Invitee", + "description": "", + "json_tag": "invitee" + }, + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "OrganizationId": { + "name": "OrganizationId", + "description": "", + "json_tag": "organization_id" + }, + "ProjectsIds": { + "name": "ProjectsIds", + "description": "", + "json_tag": "projects_ids" + }, + "Roles": { + "name": "Roles", + "description": "", + "json_tag": "roles" + } + } + }, + "InvitationList": { + "type_name": "InvitationList", + "description": "InvitationList struct for InvitationList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Invitations": { + "name": "Invitations", + "description": "", + "json_tag": "invitations" + } + } + }, + "Invoice": { + "type_name": "Invoice", + "description": "Invoice struct for Invoice", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Amount": { + "name": "Amount", + "description": "", + "json_tag": "amount" + }, + "Balance": { + "name": "Balance", + "description": "", + "json_tag": "balance" + }, + "CreatedOn": { + "name": "CreatedOn", + "description": "", + "json_tag": "created_on" + }, + "CreditAmount": { + "name": "CreditAmount", + "description": "", + "json_tag": "credit_amount" + }, + "CreditsApplied": { + "name": "CreditsApplied", + "description": "", + "json_tag": "credits_applied" + }, + "Currency": { + "name": "Currency", + "description": "", + "json_tag": "currency" + }, + "DueOn": { + "name": "DueOn", + "description": "", + "json_tag": "due_on" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Items": { + "name": "Items", + "description": "", + "json_tag": "items" + }, + "Number": { + "name": "Number", + "description": "", + "json_tag": "number" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "ReferenceNumber": { + "name": "ReferenceNumber", + "description": "", + "json_tag": "reference_number" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "TargetDate": { + "name": "TargetDate", + "description": "", + "json_tag": "target_date" + } + } + }, + "InvoiceList": { + "type_name": "InvoiceList", + "description": "InvoiceList struct for InvoiceList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Invoices": { + "name": "Invoices", + "description": "", + "json_tag": "invoices" + } + } + }, + "License": { + "type_name": "License", + "description": "License struct for License", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "LicenseKey": { + "name": "LicenseKey", + "description": "", + "json_tag": "license_key" + }, + "LicenseeProduct": { + "name": "LicenseeProduct", + "description": "", + "json_tag": "licensee_product" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Size": { + "name": "Size", + "description": "", + "json_tag": "size" + } + } + }, + "LicenseCreateInput": { + "type_name": "LicenseCreateInput", + "description": "LicenseCreateInput struct for LicenseCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "LicenseeProductId": { + "name": "LicenseeProductId", + "description": "", + "json_tag": "licensee_product_id" + }, + "Size": { + "name": "Size", + "description": "", + "json_tag": "size" + } + } + }, + "LicenseList": { + "type_name": "LicenseList", + "description": "LicenseList struct for LicenseList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Licenses": { + "name": "Licenses", + "description": "", + "json_tag": "licenses" + } + } + }, + "LicenseUpdateInput": { + "type_name": "LicenseUpdateInput", + "description": "LicenseUpdateInput struct for LicenseUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Size": { + "name": "Size", + "description": "", + "json_tag": "size" + } + } + }, + "LineItem": { + "type_name": "LineItem", + "description": "LineItem struct for LineItem", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Adjustments": { + "name": "Adjustments", + "description": "Adjustments for the line item", + "json_tag": "adjustments" + }, + "Amount": { + "name": "Amount", + "description": "", + "json_tag": "amount" + }, + "Currency": { + "name": "Currency", + "description": "", + "json_tag": "currency" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "EndDate": { + "name": "EndDate", + "description": "", + "json_tag": "end_date" + }, + "Hostname": { + "name": "Hostname", + "description": "", + "json_tag": "hostname" + }, + "ItemType": { + "name": "ItemType", + "description": "", + "json_tag": "item_type" + }, + "Location": { + "name": "Location", + "description": "", + "json_tag": "location" + }, + "Plan": { + "name": "Plan", + "description": "", + "json_tag": "plan" + }, + "PlanId": { + "name": "PlanId", + "description": "", + "json_tag": "plan_id" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "ProjectId": { + "name": "ProjectId", + "description": "", + "json_tag": "project_id" + }, + "ServiceId": { + "name": "ServiceId", + "description": "", + "json_tag": "service_id" + }, + "StartDate": { + "name": "StartDate", + "description": "", + "json_tag": "start_date" + }, + "Unit": { + "name": "Unit", + "description": "", + "json_tag": "unit" + }, + "UnitPrice": { + "name": "UnitPrice", + "description": "", + "json_tag": "unit_price" + } + } + }, + "LineItemAdjustment": { + "type_name": "LineItemAdjustment", + "description": "LineItemAdjustment struct for LineItemAdjustment", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Amount": { + "name": "Amount", + "description": "", + "json_tag": "amount" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + } + } + }, + "Membership": { + "type_name": "Membership", + "description": "Membership struct for Membership", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Roles": { + "name": "Roles", + "description": "", + "json_tag": "roles" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "User": { + "name": "User", + "description": "", + "json_tag": "user" + } + } + }, + "MembershipInput": { + "type_name": "MembershipInput", + "description": "MembershipInput struct for MembershipInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Role": { + "name": "Role", + "description": "", + "json_tag": "role" + } + } + }, + "MembershipList": { + "type_name": "MembershipList", + "description": "MembershipList struct for MembershipList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Memberships": { + "name": "Memberships", + "description": "", + "json_tag": "memberships" + } + } + }, + "Meta": { + "type_name": "Meta", + "description": "Meta struct for Meta", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CurrentPage": { + "name": "CurrentPage", + "description": "", + "json_tag": "current_page" + }, + "First": { + "name": "First", + "description": "", + "json_tag": "first" + }, + "Last": { + "name": "Last", + "description": "", + "json_tag": "last" + }, + "LastPage": { + "name": "LastPage", + "description": "", + "json_tag": "last_page" + }, + "Next": { + "name": "Next", + "description": "", + "json_tag": "next" + }, + "Previous": { + "name": "Previous", + "description": "", + "json_tag": "previous" + }, + "Self": { + "name": "Self", + "description": "", + "json_tag": "self" + }, + "Total": { + "name": "Total", + "description": "", + "json_tag": "total" + } + } + }, + "Metadata": { + "type_name": "Metadata", + "description": "Metadata struct for Metadata", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Class": { + "name": "Class", + "description": "", + "json_tag": "class" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Facility": { + "name": "Facility", + "description": "The facility code of the instance", + "json_tag": "facility" + }, + "Hostname": { + "name": "Hostname", + "description": "", + "json_tag": "hostname" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Iqn": { + "name": "Iqn", + "description": "", + "json_tag": "iqn" + }, + "Metro": { + "name": "Metro", + "description": "The metro code of the instance", + "json_tag": "metro" + }, + "Network": { + "name": "Network", + "description": "", + "json_tag": "network" + }, + "OperatingSystem": { + "name": "OperatingSystem", + "description": "", + "json_tag": "operating_system" + }, + "Plan": { + "name": "Plan", + "description": "The plan slug of the instance", + "json_tag": "plan" + }, + "PrivateSubnets": { + "name": "PrivateSubnets", + "description": "An array of the private subnets", + "json_tag": "private_subnets" + }, + "Reserved": { + "name": "Reserved", + "description": "", + "json_tag": "reserved" + }, + "Specs": { + "name": "Specs", + "description": "The specs of the plan version of the instance", + "json_tag": "specs" + }, + "SshKeys": { + "name": "SshKeys", + "description": "", + "json_tag": "ssh_keys" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "SwitchShortId": { + "name": "SwitchShortId", + "description": "", + "json_tag": "switch_short_id" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Volumes": { + "name": "Volumes", + "description": "", + "json_tag": "volumes" + } + } + }, + "MetadataNetwork": { + "type_name": "MetadataNetwork", + "description": "MetadataNetwork struct for MetadataNetwork", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Addresses": { + "name": "Addresses", + "description": "", + "json_tag": "addresses" + }, + "Interfaces": { + "name": "Interfaces", + "description": "", + "json_tag": "interfaces" + }, + "Network": { + "name": "Network", + "description": "", + "json_tag": "network" + } + } + }, + "MetadataNetworkNetwork": { + "type_name": "MetadataNetworkNetwork", + "description": "MetadataNetworkNetwork struct for MetadataNetworkNetwork", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bonding": { + "name": "Bonding", + "description": "", + "json_tag": "bonding" + } + } + }, + "MetadataNetworkNetworkBonding": { + "type_name": "MetadataNetworkNetworkBonding", + "description": "MetadataNetworkNetworkBonding struct for MetadataNetworkNetworkBonding", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "LinkAggregation": { + "name": "LinkAggregation", + "description": "", + "json_tag": "link_aggregation" + }, + "Mac": { + "name": "Mac", + "description": "", + "json_tag": "mac" + }, + "Mode": { + "name": "Mode", + "description": "", + "json_tag": "mode" + } + } + }, + "MetalGateway": { + "type_name": "MetalGateway", + "description": "MetalGateway struct for MetalGateway", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "", + "json_tag": "created_by" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "IpReservation": { + "name": "IpReservation", + "description": "", + "json_tag": "ip_reservation" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "VirtualNetwork": { + "name": "VirtualNetwork", + "description": "", + "json_tag": "virtual_network" + } + } + }, + "MetalGatewayCreateInput": { + "type_name": "MetalGatewayCreateInput", + "description": "MetalGatewayCreateInput struct for MetalGatewayCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "IpReservationId": { + "name": "IpReservationId", + "description": "The UUID of an IP reservation that belongs to the same project as where the metal gateway will be created in. This field is required unless the private IPv4 subnet size is specified.", + "json_tag": "ip_reservation_id" + }, + "PrivateIpv4SubnetSize": { + "name": "PrivateIpv4SubnetSize", + "description": "The subnet size (8, 16, 32, 64, or 128) of the private IPv4 reservation that will be created for the metal gateway. This field is required unless a project IP reservation was specified. Please keep in mind that the number of private metal gateway ranges are limited per project. If you would like to increase the limit per project, please contact support for assistance.", + "json_tag": "private_ipv4_subnet_size" + }, + "VirtualNetworkId": { + "name": "VirtualNetworkId", + "description": "The UUID of a metro virtual network that belongs to the same project as where the metal gateway will be created in.", + "json_tag": "virtual_network_id" + } + } + }, + "MetalGatewayElasticIpCreateInput": { + "type_name": "MetalGatewayElasticIpCreateInput", + "description": "MetalGatewayElasticIpCreateInput struct for MetalGatewayElasticIpCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "An IP address (or IP Address range) contained within one of the project's IP Reservations", + "json_tag": "address" + }, + "Customdata": { + "name": "Customdata", + "description": "Optional User-defined JSON object value.", + "json_tag": "customdata" + }, + "NextHop": { + "name": "NextHop", + "description": "An IP address contained within the Metal Gateways' IP Reservation range.", + "json_tag": "next_hop" + }, + "Tags": { + "name": "Tags", + "description": "Optional list of User-defined tags. Can be used by users to provide additional details or context regarding the purpose or usage of this resource.", + "json_tag": "tags" + } + } + }, + "MetalGatewayList": { + "type_name": "MetalGatewayList", + "description": "MetalGatewayList struct for MetalGatewayList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + }, + "MetalGateways": { + "name": "MetalGateways", + "description": "", + "json_tag": "metal_gateways" + } + } + }, + "MetalGatewayListMetalGatewaysInner": { + "type_name": "MetalGatewayListMetalGatewaysInner", + "description": "MetalGatewayListMetalGatewaysInner struct for MetalGatewayListMetalGatewaysInner", + "fields": { + "MetalGateway": { + "name": "MetalGateway", + "description": "" + }, + "VrfMetalGateway": { + "name": "VrfMetalGateway", + "description": "" + } + } + }, + "MetalGatewayLite": { + "type_name": "MetalGatewayLite", + "description": "MetalGatewayLite struct for MetalGatewayLite", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "GatewayAddress": { + "name": "GatewayAddress", + "description": "The gateway address with subnet CIDR value for this Metal Gateway. For example, a Metal Gateway using an IP reservation with block 10.1.2.0/27 would have a gateway address of 10.1.2.1/27.", + "json_tag": "gateway_address" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "Vlan": { + "name": "Vlan", + "description": "The VLAN id of the Virtual Network record associated to this Metal Gateway.", + "json_tag": "vlan" + } + } + }, + "Metro": { + "type_name": "Metro", + "description": "Metro struct for Metro", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Country": { + "name": "Country", + "description": "", + "json_tag": "country" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "MetroInput": { + "type_name": "MetroInput", + "description": "MetroInput struct for MetroInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Metro": { + "name": "Metro", + "description": "Metro code or ID of where the device should be provisioned in, or it can be instructed to create the device in the best available metro with `{ \\\"metro\\\": \\\"any\\\" }`. The special metro value of any means anywhere, any metro. When any is chosen in the request, the metro location is picked per our scheduling algorithms that favor the following factors: hardware reservation location (if requesting reserved hardware), ip reservations, spot instances, etc. The any keyword *does not* optimize for cost, this means that usage costs (instance, transfer, other features dependent on location) will vary. Please check metro value in response to see where the device was created. Either metro or facility must be provided.", + "json_tag": "metro" + } + } + }, + "MetroList": { + "type_name": "MetroList", + "description": "MetroList struct for MetroList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Metros": { + "name": "Metros", + "description": "", + "json_tag": "metros" + } + } + }, + "Mount": { + "type_name": "Mount", + "description": "Mount struct for Mount", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Device": { + "name": "Device", + "description": "", + "json_tag": "device" + }, + "Format": { + "name": "Format", + "description": "", + "json_tag": "format" + }, + "Options": { + "name": "Options", + "description": "", + "json_tag": "options" + }, + "Point": { + "name": "Point", + "description": "", + "json_tag": "point" + } + } + }, + "MoveHardwareReservationRequest": { + "type_name": "MoveHardwareReservationRequest", + "description": "MoveHardwareReservationRequest struct for MoveHardwareReservationRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ProjectId": { + "name": "ProjectId", + "description": "", + "json_tag": "project_id" + } + } + }, + "NewPassword": { + "type_name": "NewPassword", + "description": "NewPassword struct for NewPassword", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "NewPassword": { + "name": "NewPassword", + "description": "", + "json_tag": "new_password" + } + } + }, + "NullableAWSFabricProvider": { + "type_name": "NullableAWSFabricProvider", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAWSFabricProviderType": { + "type_name": "NullableAWSFabricProviderType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableActivateHardwareReservationRequest": { + "type_name": "NullableActivateHardwareReservationRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAddress": { + "type_name": "NullableAddress", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAttribute": { + "type_name": "NullableAttribute", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAttributeData": { + "type_name": "NullableAttributeData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAuthToken": { + "type_name": "NullableAuthToken", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAuthTokenInput": { + "type_name": "NullableAuthTokenInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAuthTokenList": { + "type_name": "NullableAuthTokenList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAuthTokenProject": { + "type_name": "NullableAuthTokenProject", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAuthTokenUser": { + "type_name": "NullableAuthTokenUser", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBGPSessionInput": { + "type_name": "NullableBGPSessionInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBGPSessionInputAddressFamily": { + "type_name": "NullableBGPSessionInputAddressFamily", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBatch": { + "type_name": "NullableBatch", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBatchesList": { + "type_name": "NullableBatchesList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpConfig": { + "type_name": "NullableBgpConfig", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpConfigDeploymentType": { + "type_name": "NullableBgpConfigDeploymentType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpConfigRequestInput": { + "type_name": "NullableBgpConfigRequestInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpConfigRequestInputDeploymentType": { + "type_name": "NullableBgpConfigRequestInputDeploymentType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpConfigStatus": { + "type_name": "NullableBgpConfigStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpDynamicNeighbor": { + "type_name": "NullableBgpDynamicNeighbor", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpDynamicNeighborCreateInput": { + "type_name": "NullableBgpDynamicNeighborCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpDynamicNeighborList": { + "type_name": "NullableBgpDynamicNeighborList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpDynamicNeighborState": { + "type_name": "NullableBgpDynamicNeighborState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpNeighborData": { + "type_name": "NullableBgpNeighborData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpRoute": { + "type_name": "NullableBgpRoute", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpSession": { + "type_name": "NullableBgpSession", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpSessionAddressFamily": { + "type_name": "NullableBgpSessionAddressFamily", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpSessionList": { + "type_name": "NullableBgpSessionList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBgpSessionNeighbors": { + "type_name": "NullableBgpSessionNeighbors", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBondPortData": { + "type_name": "NullableBondPortData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBool": { + "type_name": "NullableBool", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCapacityCheckPerFacilityInfo": { + "type_name": "NullableCapacityCheckPerFacilityInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCapacityCheckPerFacilityList": { + "type_name": "NullableCapacityCheckPerFacilityList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCapacityCheckPerMetroInfo": { + "type_name": "NullableCapacityCheckPerMetroInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCapacityCheckPerMetroList": { + "type_name": "NullableCapacityCheckPerMetroList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCapacityInput": { + "type_name": "NullableCapacityInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCapacityLevelPerBaremetal": { + "type_name": "NullableCapacityLevelPerBaremetal", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCapacityList": { + "type_name": "NullableCapacityList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableComponent": { + "type_name": "NullableComponent", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCoordinates": { + "type_name": "NullableCoordinates", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCreateDeviceRequest": { + "type_name": "NullableCreateDeviceRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCreateEmailInput": { + "type_name": "NullableCreateEmailInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCreateMetalGatewayRequest": { + "type_name": "NullableCreateMetalGatewayRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCreateOrganizationInterconnectionRequest": { + "type_name": "NullableCreateOrganizationInterconnectionRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCreateSelfServiceReservationRequest": { + "type_name": "NullableCreateSelfServiceReservationRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCreateSelfServiceReservationRequestPeriod": { + "type_name": "NullableCreateSelfServiceReservationRequestPeriod", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCreateSelfServiceReservationRequestPeriodCount": { + "type_name": "NullableCreateSelfServiceReservationRequestPeriodCount", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCreateSelfServiceReservationRequestPeriodUnit": { + "type_name": "NullableCreateSelfServiceReservationRequestPeriodUnit", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDedicatedPortCreateInput": { + "type_name": "NullableDedicatedPortCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDedicatedPortCreateInputMode": { + "type_name": "NullableDedicatedPortCreateInputMode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDedicatedPortCreateInputType": { + "type_name": "NullableDedicatedPortCreateInputType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDevice": { + "type_name": "NullableDevice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceActionInput": { + "type_name": "NullableDeviceActionInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceActionInputType": { + "type_name": "NullableDeviceActionInputType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceActionsInner": { + "type_name": "NullableDeviceActionsInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceCreateInFacilityInput": { + "type_name": "NullableDeviceCreateInFacilityInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceCreateInMetroInput": { + "type_name": "NullableDeviceCreateInMetroInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceCreateInput": { + "type_name": "NullableDeviceCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceCreateInputBillingCycle": { + "type_name": "NullableDeviceCreateInputBillingCycle", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceCreatedBy": { + "type_name": "NullableDeviceCreatedBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceHealthRollup": { + "type_name": "NullableDeviceHealthRollup", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceHealthRollupHealthRollup": { + "type_name": "NullableDeviceHealthRollupHealthRollup", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceList": { + "type_name": "NullableDeviceList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceMetro": { + "type_name": "NullableDeviceMetro", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceProjectLite": { + "type_name": "NullableDeviceProjectLite", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceState": { + "type_name": "NullableDeviceState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceUpdateInput": { + "type_name": "NullableDeviceUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceUsage": { + "type_name": "NullableDeviceUsage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDeviceUsageList": { + "type_name": "NullableDeviceUsageList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDisk": { + "type_name": "NullableDisk", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableEmail": { + "type_name": "NullableEmail", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableEmailInput": { + "type_name": "NullableEmailInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableEntitlement": { + "type_name": "NullableEntitlement", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableError": { + "type_name": "NullableError", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableEvent": { + "type_name": "NullableEvent", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableEventList": { + "type_name": "NullableEventList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricServiceToken": { + "type_name": "NullableFabricServiceToken", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricServiceTokenRole": { + "type_name": "NullableFabricServiceTokenRole", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricServiceTokenServiceTokenType": { + "type_name": "NullableFabricServiceTokenServiceTokenType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricServiceTokenState": { + "type_name": "NullableFabricServiceTokenState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFacility": { + "type_name": "NullableFacility", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFacilityFeaturesInner": { + "type_name": "NullableFacilityFeaturesInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFacilityInput": { + "type_name": "NullableFacilityInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFacilityList": { + "type_name": "NullableFacilityList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFilesystem": { + "type_name": "NullableFilesystem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindFacilitiesIncludeParameterInner": { + "type_name": "NullableFindFacilitiesIncludeParameterInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindIPAddressById200Response": { + "type_name": "NullableFindIPAddressById200Response", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindIPAvailabilitiesCidrParameter": { + "type_name": "NullableFindIPAvailabilitiesCidrParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindIPReservationsTypesParameterInner": { + "type_name": "NullableFindIPReservationsTypesParameterInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindMetalGatewayById200Response": { + "type_name": "NullableFindMetalGatewayById200Response", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindOrganizationDevicesCategoriesParameterInner": { + "type_name": "NullableFindOrganizationDevicesCategoriesParameterInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindOrganizationsPersonalParameter": { + "type_name": "NullableFindOrganizationsPersonalParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindPlansTypeParameter": { + "type_name": "NullableFindPlansTypeParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindProjectHardwareReservationsProvisionableParameter": { + "type_name": "NullableFindProjectHardwareReservationsProvisionableParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindProjectHardwareReservationsStateParameter": { + "type_name": "NullableFindProjectHardwareReservationsStateParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindTrafficBucketParameter": { + "type_name": "NullableFindTrafficBucketParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindTrafficDirectionParameter": { + "type_name": "NullableFindTrafficDirectionParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindTrafficIntervalParameter": { + "type_name": "NullableFindTrafficIntervalParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFindTrafficTimeframeParameter": { + "type_name": "NullableFindTrafficTimeframeParameter", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFirmwareSet": { + "type_name": "NullableFirmwareSet", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFirmwareSetListResponse": { + "type_name": "NullableFirmwareSetListResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFirmwareSetResponse": { + "type_name": "NullableFirmwareSetResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat32": { + "type_name": "NullableFloat32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat64": { + "type_name": "NullableFloat64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGlobalBgpRange": { + "type_name": "NullableGlobalBgpRange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGlobalBgpRangeList": { + "type_name": "NullableGlobalBgpRangeList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableHardwareReservation": { + "type_name": "NullableHardwareReservation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableHardwareReservationList": { + "type_name": "NullableHardwareReservationList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableHref": { + "type_name": "NullableHref", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPAddress": { + "type_name": "NullableIPAddress", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPAddressAddressFamily": { + "type_name": "NullableIPAddressAddressFamily", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPAssignment": { + "type_name": "NullableIPAssignment", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPAssignmentInput": { + "type_name": "NullableIPAssignmentInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPAssignmentList": { + "type_name": "NullableIPAssignmentList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPAssignmentMetro": { + "type_name": "NullableIPAssignmentMetro", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPAssignmentState": { + "type_name": "NullableIPAssignmentState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPAssignmentType": { + "type_name": "NullableIPAssignmentType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPAssignmentUpdateInput": { + "type_name": "NullableIPAssignmentUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPAvailabilitiesList": { + "type_name": "NullableIPAvailabilitiesList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPReservation": { + "type_name": "NullableIPReservation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPReservationFacility": { + "type_name": "NullableIPReservationFacility", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPReservationList": { + "type_name": "NullableIPReservationList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPReservationListIpAddressesInner": { + "type_name": "NullableIPReservationListIpAddressesInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPReservationMetro": { + "type_name": "NullableIPReservationMetro", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPReservationRequestInput": { + "type_name": "NullableIPReservationRequestInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIPReservationType": { + "type_name": "NullableIPReservationType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInstancesBatchCreateInput": { + "type_name": "NullableInstancesBatchCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInstancesBatchCreateInputBatchesInner": { + "type_name": "NullableInstancesBatchCreateInputBatchesInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt": { + "type_name": "NullableInt", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt32": { + "type_name": "NullableInt32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt64": { + "type_name": "NullableInt64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnection": { + "type_name": "NullableInterconnection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionFabricProvider": { + "type_name": "NullableInterconnectionFabricProvider", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionList": { + "type_name": "NullableInterconnectionList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionMetroList": { + "type_name": "NullableInterconnectionMetroList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionMetroListMetrosInner": { + "type_name": "NullableInterconnectionMetroListMetrosInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionMetroListMetrosInnerAllOfProvidersInner": { + "type_name": "NullableInterconnectionMetroListMetrosInnerAllOfProvidersInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionMode": { + "type_name": "NullableInterconnectionMode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionPort": { + "type_name": "NullableInterconnectionPort", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionPortList": { + "type_name": "NullableInterconnectionPortList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionPortRole": { + "type_name": "NullableInterconnectionPortRole", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionPortStatus": { + "type_name": "NullableInterconnectionPortStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionPricingList": { + "type_name": "NullableInterconnectionPricingList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionPricingListProviderPricingInner": { + "type_name": "NullableInterconnectionPricingListProviderPricingInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionPricingListProviderPricingInnerTiersInner": { + "type_name": "NullableInterconnectionPricingListProviderPricingInnerTiersInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionRedundancy": { + "type_name": "NullableInterconnectionRedundancy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionType": { + "type_name": "NullableInterconnectionType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInterconnectionUpdateInput": { + "type_name": "NullableInterconnectionUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInvitation": { + "type_name": "NullableInvitation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInvitationInput": { + "type_name": "NullableInvitationInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInvitationList": { + "type_name": "NullableInvitationList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInvitationRolesInner": { + "type_name": "NullableInvitationRolesInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInvoice": { + "type_name": "NullableInvoice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInvoiceList": { + "type_name": "NullableInvoiceList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLicense": { + "type_name": "NullableLicense", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLicenseCreateInput": { + "type_name": "NullableLicenseCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLicenseList": { + "type_name": "NullableLicenseList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLicenseUpdateInput": { + "type_name": "NullableLicenseUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLineItem": { + "type_name": "NullableLineItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLineItemAdjustment": { + "type_name": "NullableLineItemAdjustment", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMembership": { + "type_name": "NullableMembership", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMembershipInput": { + "type_name": "NullableMembershipInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMembershipList": { + "type_name": "NullableMembershipList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMeta": { + "type_name": "NullableMeta", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetadata": { + "type_name": "NullableMetadata", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetadataNetwork": { + "type_name": "NullableMetadataNetwork", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetadataNetworkNetwork": { + "type_name": "NullableMetadataNetworkNetwork", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetadataNetworkNetworkBonding": { + "type_name": "NullableMetadataNetworkNetworkBonding", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetalGateway": { + "type_name": "NullableMetalGateway", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetalGatewayCreateInput": { + "type_name": "NullableMetalGatewayCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetalGatewayElasticIpCreateInput": { + "type_name": "NullableMetalGatewayElasticIpCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetalGatewayList": { + "type_name": "NullableMetalGatewayList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetalGatewayListMetalGatewaysInner": { + "type_name": "NullableMetalGatewayListMetalGatewaysInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetalGatewayLite": { + "type_name": "NullableMetalGatewayLite", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetalGatewayState": { + "type_name": "NullableMetalGatewayState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetro": { + "type_name": "NullableMetro", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetroInput": { + "type_name": "NullableMetroInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMetroList": { + "type_name": "NullableMetroList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMount": { + "type_name": "NullableMount", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMoveHardwareReservationRequest": { + "type_name": "NullableMoveHardwareReservationRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNewPassword": { + "type_name": "NullableNewPassword", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOperatingSystem": { + "type_name": "NullableOperatingSystem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOperatingSystemList": { + "type_name": "NullableOperatingSystemList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrganization": { + "type_name": "NullableOrganization", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrganizationInput": { + "type_name": "NullableOrganizationInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrganizationList": { + "type_name": "NullableOrganizationList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableParentBlock": { + "type_name": "NullableParentBlock", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePartition": { + "type_name": "NullablePartition", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePaymentMethod": { + "type_name": "NullablePaymentMethod", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePaymentMethodBillingAddress": { + "type_name": "NullablePaymentMethodBillingAddress", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePaymentMethodCreateInput": { + "type_name": "NullablePaymentMethodCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePaymentMethodList": { + "type_name": "NullablePaymentMethodList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePaymentMethodUpdateInput": { + "type_name": "NullablePaymentMethodUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlan": { + "type_name": "NullablePlan", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanAvailableInInner": { + "type_name": "NullablePlanAvailableInInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanAvailableInInnerPrice": { + "type_name": "NullablePlanAvailableInInnerPrice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanAvailableInMetrosInner": { + "type_name": "NullablePlanAvailableInMetrosInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanDeploymentTypesInner": { + "type_name": "NullablePlanDeploymentTypesInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanIdName": { + "type_name": "NullablePlanIdName", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanList": { + "type_name": "NullablePlanList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanSpecs": { + "type_name": "NullablePlanSpecs", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanSpecsCpusInner": { + "type_name": "NullablePlanSpecsCpusInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanSpecsDrivesInner": { + "type_name": "NullablePlanSpecsDrivesInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanSpecsFeatures": { + "type_name": "NullablePlanSpecsFeatures", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanSpecsMemory": { + "type_name": "NullablePlanSpecsMemory", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanSpecsNicsInner": { + "type_name": "NullablePlanSpecsNicsInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePlanType": { + "type_name": "NullablePlanType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePort": { + "type_name": "NullablePort", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortAssignInput": { + "type_name": "NullablePortAssignInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortConvertLayer3Input": { + "type_name": "NullablePortConvertLayer3Input", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortConvertLayer3InputRequestIpsInner": { + "type_name": "NullablePortConvertLayer3InputRequestIpsInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortData": { + "type_name": "NullablePortData", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortNetworkType": { + "type_name": "NullablePortNetworkType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortType": { + "type_name": "NullablePortType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortVlanAssignment": { + "type_name": "NullablePortVlanAssignment", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortVlanAssignmentBatch": { + "type_name": "NullablePortVlanAssignmentBatch", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortVlanAssignmentBatchCreateInput": { + "type_name": "NullablePortVlanAssignmentBatchCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortVlanAssignmentBatchCreateInputVlanAssignmentsInner": { + "type_name": "NullablePortVlanAssignmentBatchCreateInputVlanAssignmentsInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortVlanAssignmentBatchList": { + "type_name": "NullablePortVlanAssignmentBatchList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortVlanAssignmentBatchState": { + "type_name": "NullablePortVlanAssignmentBatchState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortVlanAssignmentBatchVlanAssignmentsInner": { + "type_name": "NullablePortVlanAssignmentBatchVlanAssignmentsInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortVlanAssignmentBatchVlanAssignmentsInnerState": { + "type_name": "NullablePortVlanAssignmentBatchVlanAssignmentsInnerState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortVlanAssignmentList": { + "type_name": "NullablePortVlanAssignmentList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePortVlanAssignmentState": { + "type_name": "NullablePortVlanAssignmentState", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProject": { + "type_name": "NullableProject", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProjectCreateFromRootInput": { + "type_name": "NullableProjectCreateFromRootInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProjectCreateFromRootInputType": { + "type_name": "NullableProjectCreateFromRootInputType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProjectCreateInput": { + "type_name": "NullableProjectCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProjectIdName": { + "type_name": "NullableProjectIdName", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProjectList": { + "type_name": "NullableProjectList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProjectType": { + "type_name": "NullableProjectType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProjectUpdateInput": { + "type_name": "NullableProjectUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProjectUsage": { + "type_name": "NullableProjectUsage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProjectUsageList": { + "type_name": "NullableProjectUsageList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRaid": { + "type_name": "NullableRaid", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRequestIPReservation201Response": { + "type_name": "NullableRequestIPReservation201Response", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRequestIPReservationRequest": { + "type_name": "NullableRequestIPReservationRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSSHKey": { + "type_name": "NullableSSHKey", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSSHKeyCreateInput": { + "type_name": "NullableSSHKeyCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSSHKeyInput": { + "type_name": "NullableSSHKeyInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSSHKeyList": { + "type_name": "NullableSSHKeyList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSelfServiceReservationItemRequest": { + "type_name": "NullableSelfServiceReservationItemRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSelfServiceReservationItemResponse": { + "type_name": "NullableSelfServiceReservationItemResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSelfServiceReservationList": { + "type_name": "NullableSelfServiceReservationList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSelfServiceReservationResponse": { + "type_name": "NullableSelfServiceReservationResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableServerInfo": { + "type_name": "NullableServerInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSharedPortVCVlanCreateInput": { + "type_name": "NullableSharedPortVCVlanCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSharedPortVCVlanCreateInputType": { + "type_name": "NullableSharedPortVCVlanCreateInputType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotMarketPricesList": { + "type_name": "NullableSpotMarketPricesList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotMarketPricesPerMetroList": { + "type_name": "NullableSpotMarketPricesPerMetroList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotMarketPricesPerMetroReport": { + "type_name": "NullableSpotMarketPricesPerMetroReport", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotMarketRequest": { + "type_name": "NullableSpotMarketRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotMarketRequestCreateInput": { + "type_name": "NullableSpotMarketRequestCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotMarketRequestCreateInputInstanceParameters": { + "type_name": "NullableSpotMarketRequestCreateInputInstanceParameters", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotMarketRequestList": { + "type_name": "NullableSpotMarketRequestList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotMarketRequestMetro": { + "type_name": "NullableSpotMarketRequestMetro", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotPricesDatapoints": { + "type_name": "NullableSpotPricesDatapoints", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotPricesHistoryReport": { + "type_name": "NullableSpotPricesHistoryReport", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotPricesPerBaremetal": { + "type_name": "NullableSpotPricesPerBaremetal", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotPricesPerFacility": { + "type_name": "NullableSpotPricesPerFacility", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotPricesPerNewFacility": { + "type_name": "NullableSpotPricesPerNewFacility", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSpotPricesReport": { + "type_name": "NullableSpotPricesReport", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableStorage": { + "type_name": "NullableStorage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableString": { + "type_name": "NullableString", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSupportRequestInput": { + "type_name": "NullableSupportRequestInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSupportRequestInputPriority": { + "type_name": "NullableSupportRequestInputPriority", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTime": { + "type_name": "NullableTime", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTransferRequest": { + "type_name": "NullableTransferRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTransferRequestInput": { + "type_name": "NullableTransferRequestInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTransferRequestList": { + "type_name": "NullableTransferRequestList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUpdateEmailInput": { + "type_name": "NullableUpdateEmailInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUser": { + "type_name": "NullableUser", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUserCreateInput": { + "type_name": "NullableUserCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUserLimited": { + "type_name": "NullableUserLimited", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUserList": { + "type_name": "NullableUserList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUserLite": { + "type_name": "NullableUserLite", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUserUpdateInput": { + "type_name": "NullableUserUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUserdata": { + "type_name": "NullableUserdata", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVerifyEmail": { + "type_name": "NullableVerifyEmail", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualCircuit": { + "type_name": "NullableVirtualCircuit", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualCircuitCreateInput": { + "type_name": "NullableVirtualCircuitCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualCircuitList": { + "type_name": "NullableVirtualCircuitList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualCircuitUpdateInput": { + "type_name": "NullableVirtualCircuitUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualNetwork": { + "type_name": "NullableVirtualNetwork", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualNetworkCreateInput": { + "type_name": "NullableVirtualNetworkCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualNetworkList": { + "type_name": "NullableVirtualNetworkList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVirtualNetworkUpdateInput": { + "type_name": "NullableVirtualNetworkUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanCSPConnectionCreateInput": { + "type_name": "NullableVlanCSPConnectionCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanCSPConnectionCreateInputFabricProvider": { + "type_name": "NullableVlanCSPConnectionCreateInputFabricProvider", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanCSPConnectionCreateInputType": { + "type_name": "NullableVlanCSPConnectionCreateInputType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanFabricVcCreateInput": { + "type_name": "NullableVlanFabricVcCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanFabricVcCreateInputServiceTokenType": { + "type_name": "NullableVlanFabricVcCreateInputServiceTokenType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanFabricVcCreateInputType": { + "type_name": "NullableVlanFabricVcCreateInputType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanVirtualCircuit": { + "type_name": "NullableVlanVirtualCircuit", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanVirtualCircuitBillType": { + "type_name": "NullableVlanVirtualCircuitBillType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanVirtualCircuitCreateInput": { + "type_name": "NullableVlanVirtualCircuitCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanVirtualCircuitStatus": { + "type_name": "NullableVlanVirtualCircuitStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanVirtualCircuitType": { + "type_name": "NullableVlanVirtualCircuitType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVlanVirtualCircuitUpdateInput": { + "type_name": "NullableVlanVirtualCircuitUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrf": { + "type_name": "NullableVrf", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfBGPNeighbors": { + "type_name": "NullableVrfBGPNeighbors", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfBGPNeighborsList": { + "type_name": "NullableVrfBGPNeighborsList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfCreateInput": { + "type_name": "NullableVrfCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfFabricVcCreateInput": { + "type_name": "NullableVrfFabricVcCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfIpReservation": { + "type_name": "NullableVrfIpReservation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfIpReservationCreateInput": { + "type_name": "NullableVrfIpReservationCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfIpReservationList": { + "type_name": "NullableVrfIpReservationList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfIpReservationType": { + "type_name": "NullableVrfIpReservationType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfLearnedRoutes": { + "type_name": "NullableVrfLearnedRoutes", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfLearnedRoutesList": { + "type_name": "NullableVrfLearnedRoutesList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfList": { + "type_name": "NullableVrfList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfMetalGateway": { + "type_name": "NullableVrfMetalGateway", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfMetalGatewayCreateInput": { + "type_name": "NullableVrfMetalGatewayCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfRoute": { + "type_name": "NullableVrfRoute", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfRouteCreateInput": { + "type_name": "NullableVrfRouteCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfRouteList": { + "type_name": "NullableVrfRouteList", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfRouteStatus": { + "type_name": "NullableVrfRouteStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfRouteType": { + "type_name": "NullableVrfRouteType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfRouteUpdateInput": { + "type_name": "NullableVrfRouteUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfUpdateInput": { + "type_name": "NullableVrfUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfVirtualCircuit": { + "type_name": "NullableVrfVirtualCircuit", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfVirtualCircuitCreateInput": { + "type_name": "NullableVrfVirtualCircuitCreateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfVirtualCircuitStatus": { + "type_name": "NullableVrfVirtualCircuitStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableVrfVirtualCircuitUpdateInput": { + "type_name": "NullableVrfVirtualCircuitUpdateInput", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "OperatingSystem": { + "type_name": "OperatingSystem", + "description": "OperatingSystem struct for OperatingSystem", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BuildDate": { + "name": "BuildDate", + "description": "The date on which the current OS image was build and released", + "json_tag": "build_date" + }, + "DefaultOperatingSystem": { + "name": "DefaultOperatingSystem", + "description": "Default operating system for the distro.", + "json_tag": "default_operating_system" + }, + "DeprecationDate": { + "name": "DeprecationDate", + "description": "The date when the OS is deprecated", + "json_tag": "deprecation_date" + }, + "Distro": { + "name": "Distro", + "description": "", + "json_tag": "distro" + }, + "DistroLabel": { + "name": "DistroLabel", + "description": "", + "json_tag": "distro_label" + }, + "EndOfLifeDate": { + "name": "EndOfLifeDate", + "description": "The OS no longer receives any updates and may be disabled at any time", + "json_tag": "end_of_life_date" + }, + "EndOfServiceDate": { + "name": "EndOfServiceDate", + "description": "When the OS is nearing end of life, typically 30 days before end of life", + "json_tag": "end_of_service_date" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Licensed": { + "name": "Licensed", + "description": "Licenced OS is priced according to pricing property", + "json_tag": "licensed" + }, + "LifecycleState": { + "name": "LifecycleState", + "description": "Where in the support lifecycle the OS is", + "json_tag": "lifecycle_state" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Preinstallable": { + "name": "Preinstallable", + "description": "Servers can be already preinstalled with OS in order to shorten provision time.", + "json_tag": "preinstallable" + }, + "Pricing": { + "name": "Pricing", + "description": "This object contains price per time unit and optional multiplier value if licence price depends on hardware plan or components (e.g. number of cores)", + "json_tag": "pricing" + }, + "ProvisionableOn": { + "name": "ProvisionableOn", + "description": "", + "json_tag": "provisionable_on" + }, + "ReleaseDate": { + "name": "ReleaseDate", + "description": "The date when the OS was released", + "json_tag": "release_date" + }, + "ReleaseNotes": { + "name": "ReleaseNotes", + "description": "The current release notes for this OS image, typically in Markdown format", + "json_tag": "release_notes" + }, + "Slug": { + "name": "Slug", + "description": "", + "json_tag": "slug" + }, + "Version": { + "name": "Version", + "description": "", + "json_tag": "version" + } + } + }, + "OperatingSystemList": { + "type_name": "OperatingSystemList", + "description": "OperatingSystemList struct for OperatingSystemList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "OperatingSystems": { + "name": "OperatingSystems", + "description": "", + "json_tag": "operating_systems" + } + } + }, + "Organization": { + "type_name": "Organization", + "description": "Organization struct for Organization", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + }, + "BillingAddress": { + "name": "BillingAddress", + "description": "", + "json_tag": "billing_address" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "CreditAmount": { + "name": "CreditAmount", + "description": "", + "json_tag": "credit_amount" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Enforce2faAt": { + "name": "Enforce2faAt", + "description": "Force to all members to have enabled the two factor authentication after that date, unless the value is null", + "json_tag": "enforce_2fa_at" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Logo": { + "name": "Logo", + "description": "", + "json_tag": "logo" + }, + "Members": { + "name": "Members", + "description": "", + "json_tag": "members" + }, + "Memberships": { + "name": "Memberships", + "description": "", + "json_tag": "memberships" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Projects": { + "name": "Projects", + "description": "", + "json_tag": "projects" + }, + "Terms": { + "name": "Terms", + "description": "", + "json_tag": "terms" + }, + "Twitter": { + "name": "Twitter", + "description": "", + "json_tag": "twitter" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "Website": { + "name": "Website", + "description": "", + "json_tag": "website" + } + } + }, + "OrganizationInput": { + "type_name": "OrganizationInput", + "description": "OrganizationInput struct for OrganizationInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + }, + "BillingAddress": { + "name": "BillingAddress", + "description": "", + "json_tag": "billing_address" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Enforce2faAt": { + "name": "Enforce2faAt", + "description": "Force to all members to have enabled the two factor authentication after that date, unless the value is null", + "json_tag": "enforce_2fa_at" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Twitter": { + "name": "Twitter", + "description": "", + "json_tag": "twitter" + }, + "Website": { + "name": "Website", + "description": "", + "json_tag": "website" + } + } + }, + "OrganizationList": { + "type_name": "OrganizationList", + "description": "OrganizationList struct for OrganizationList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + }, + "Organizations": { + "name": "Organizations", + "description": "", + "json_tag": "organizations" + } + } + }, + "ParentBlock": { + "type_name": "ParentBlock", + "description": "ParentBlock struct for ParentBlock", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cidr": { + "name": "Cidr", + "description": "", + "json_tag": "cidr" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Netmask": { + "name": "Netmask", + "description": "", + "json_tag": "netmask" + }, + "Network": { + "name": "Network", + "description": "", + "json_tag": "network" + } + } + }, + "Partition": { + "type_name": "Partition", + "description": "Partition struct for Partition", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Label": { + "name": "Label", + "description": "", + "json_tag": "label" + }, + "Number": { + "name": "Number", + "description": "", + "json_tag": "number" + }, + "Size": { + "name": "Size", + "description": "", + "json_tag": "size" + } + } + }, + "PaymentMethod": { + "type_name": "PaymentMethod", + "description": "PaymentMethod struct for PaymentMethod", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BillingAddress": { + "name": "BillingAddress", + "description": "", + "json_tag": "billing_address" + }, + "CardType": { + "name": "CardType", + "description": "", + "json_tag": "card_type" + }, + "CardholderName": { + "name": "CardholderName", + "description": "", + "json_tag": "cardholder_name" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "CreatedByUser": { + "name": "CreatedByUser", + "description": "", + "json_tag": "created_by_user" + }, + "Default": { + "name": "Default", + "description": "", + "json_tag": "default" + }, + "Email": { + "name": "Email", + "description": "", + "json_tag": "email" + }, + "ExpirationMonth": { + "name": "ExpirationMonth", + "description": "", + "json_tag": "expiration_month" + }, + "ExpirationYear": { + "name": "ExpirationYear", + "description": "", + "json_tag": "expiration_year" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Organization": { + "name": "Organization", + "description": "", + "json_tag": "organization" + }, + "Projects": { + "name": "Projects", + "description": "", + "json_tag": "projects" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + } + } + }, + "PaymentMethodBillingAddress": { + "type_name": "PaymentMethodBillingAddress", + "description": "PaymentMethodBillingAddress struct for PaymentMethodBillingAddress", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CountryCodeAlpha2": { + "name": "CountryCodeAlpha2", + "description": "", + "json_tag": "country_code_alpha2" + }, + "PostalCode": { + "name": "PostalCode", + "description": "", + "json_tag": "postal_code" + }, + "StreetAddress": { + "name": "StreetAddress", + "description": "", + "json_tag": "street_address" + } + } + }, + "PaymentMethodCreateInput": { + "type_name": "PaymentMethodCreateInput", + "description": "PaymentMethodCreateInput struct for PaymentMethodCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Default": { + "name": "Default", + "description": "", + "json_tag": "default" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Nonce": { + "name": "Nonce", + "description": "", + "json_tag": "nonce" + } + } + }, + "PaymentMethodList": { + "type_name": "PaymentMethodList", + "description": "PaymentMethodList struct for PaymentMethodList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "PaymentMethods": { + "name": "PaymentMethods", + "description": "", + "json_tag": "payment_methods" + } + } + }, + "PaymentMethodUpdateInput": { + "type_name": "PaymentMethodUpdateInput", + "description": "PaymentMethodUpdateInput struct for PaymentMethodUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BillingAddress": { + "name": "BillingAddress", + "description": "", + "json_tag": "billing_address" + }, + "CardholderName": { + "name": "CardholderName", + "description": "", + "json_tag": "cardholder_name" + }, + "Default": { + "name": "Default", + "description": "", + "json_tag": "default" + }, + "ExpirationMonth": { + "name": "ExpirationMonth", + "description": "", + "json_tag": "expiration_month" + }, + "ExpirationYear": { + "name": "ExpirationYear", + "description": "", + "json_tag": "expiration_year" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "Plan": { + "type_name": "Plan", + "description": "Plan struct for Plan", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AvailableIn": { + "name": "AvailableIn", + "description": "Shows which facilities the plan is available in, and the facility-based price if it is different from the default price.", + "json_tag": "available_in" + }, + "AvailableInMetros": { + "name": "AvailableInMetros", + "description": "Shows which metros the plan is available in, and the metro-based price if it is different from the default price.", + "json_tag": "available_in_metros" + }, + "Categories": { + "name": "Categories", + "description": "Categories of the plan, like compute or storage. A Plan can belong to multiple categories.", + "json_tag": "categories" + }, + "Class": { + "name": "Class", + "description": "", + "json_tag": "class" + }, + "DeploymentTypes": { + "name": "DeploymentTypes", + "description": "", + "json_tag": "deployment_types" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Legacy": { + "name": "Legacy", + "description": "Deprecated. Always return false", + "json_tag": "legacy" + }, + "Line": { + "name": "Line", + "description": "", + "json_tag": "line" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Pricing": { + "name": "Pricing", + "description": "", + "json_tag": "pricing" + }, + "Slug": { + "name": "Slug", + "description": "", + "json_tag": "slug" + }, + "Specs": { + "name": "Specs", + "description": "", + "json_tag": "specs" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "PlanAvailableInInner": { + "type_name": "PlanAvailableInInner", + "description": "PlanAvailableInInner struct for PlanAvailableInInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "href to the Facility", + "json_tag": "href" + }, + "Price": { + "name": "Price", + "description": "", + "json_tag": "price" + } + } + }, + "PlanAvailableInInnerPrice": { + "type_name": "PlanAvailableInInnerPrice", + "description": "PlanAvailableInInnerPrice struct for PlanAvailableInInnerPrice", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Hour": { + "name": "Hour", + "description": "", + "json_tag": "hour" + } + } + }, + "PlanAvailableInMetrosInner": { + "type_name": "PlanAvailableInMetrosInner", + "description": "PlanAvailableInMetrosInner struct for PlanAvailableInMetrosInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "href to the Metro", + "json_tag": "href" + }, + "Price": { + "name": "Price", + "description": "", + "json_tag": "price" + } + } + }, + "PlanIdName": { + "type_name": "PlanIdName", + "description": "PlanIdName struct for PlanIdName", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "PlanList": { + "type_name": "PlanList", + "description": "PlanList struct for PlanList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Plans": { + "name": "Plans", + "description": "", + "json_tag": "plans" + } + } + }, + "PlanSpecs": { + "type_name": "PlanSpecs", + "description": "PlanSpecs struct for PlanSpecs", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cpus": { + "name": "Cpus", + "description": "", + "json_tag": "cpus" + }, + "Drives": { + "name": "Drives", + "description": "", + "json_tag": "drives" + }, + "Features": { + "name": "Features", + "description": "", + "json_tag": "features" + }, + "Memory": { + "name": "Memory", + "description": "", + "json_tag": "memory" + }, + "Nics": { + "name": "Nics", + "description": "", + "json_tag": "nics" + } + } + }, + "PlanSpecsCpusInner": { + "type_name": "PlanSpecsCpusInner", + "description": "PlanSpecsCpusInner struct for PlanSpecsCpusInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Count": { + "name": "Count", + "description": "", + "json_tag": "count" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "PlanSpecsDrivesInner": { + "type_name": "PlanSpecsDrivesInner", + "description": "PlanSpecsDrivesInner struct for PlanSpecsDrivesInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Category": { + "name": "Category", + "description": "Values may include 'boot', 'cache', 'storage'", + "json_tag": "category" + }, + "Count": { + "name": "Count", + "description": "", + "json_tag": "count" + }, + "Size": { + "name": "Size", + "description": "", + "json_tag": "size" + }, + "Type": { + "name": "Type", + "description": "Values may include 'HDD', 'SSD', 'NVME'", + "json_tag": "type" + } + } + }, + "PlanSpecsFeatures": { + "type_name": "PlanSpecsFeatures", + "description": "PlanSpecsFeatures struct for PlanSpecsFeatures", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Raid": { + "name": "Raid", + "description": "", + "json_tag": "raid" + }, + "Txt": { + "name": "Txt", + "description": "", + "json_tag": "txt" + }, + "Uefi": { + "name": "Uefi", + "description": "", + "json_tag": "uefi" + } + } + }, + "PlanSpecsMemory": { + "type_name": "PlanSpecsMemory", + "description": "PlanSpecsMemory struct for PlanSpecsMemory", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Total": { + "name": "Total", + "description": "", + "json_tag": "total" + } + } + }, + "PlanSpecsNicsInner": { + "type_name": "PlanSpecsNicsInner", + "description": "PlanSpecsNicsInner struct for PlanSpecsNicsInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Count": { + "name": "Count", + "description": "", + "json_tag": "count" + }, + "Type": { + "name": "Type", + "description": "Values may include '1Gbps', '10Gbps', '25Gbps'", + "json_tag": "type" + } + } + }, + "Port": { + "type_name": "Port", + "description": "Port Port is a hardware port associated with a reserved or instantiated hardware device.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bond": { + "name": "Bond", + "description": "", + "json_tag": "bond" + }, + "Data": { + "name": "Data", + "description": "", + "json_tag": "data" + }, + "DisbondOperationSupported": { + "name": "DisbondOperationSupported", + "description": "Indicates whether or not the bond can be broken on the port (when applicable).", + "json_tag": "disbond_operation_supported" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "NativeVirtualNetwork": { + "name": "NativeVirtualNetwork", + "description": "", + "json_tag": "native_virtual_network" + }, + "NetworkType": { + "name": "NetworkType", + "description": "", + "json_tag": "network_type" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "VirtualNetworks": { + "name": "VirtualNetworks", + "description": "", + "json_tag": "virtual_networks" + } + } + }, + "PortAssignInput": { + "type_name": "PortAssignInput", + "description": "PortAssignInput struct for PortAssignInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Vnid": { + "name": "Vnid", + "description": "Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself.", + "json_tag": "vnid" + } + } + }, + "PortConvertLayer3Input": { + "type_name": "PortConvertLayer3Input", + "description": "PortConvertLayer3Input struct for PortConvertLayer3Input", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "RequestIps": { + "name": "RequestIps", + "description": "", + "json_tag": "request_ips" + } + } + }, + "PortConvertLayer3InputRequestIpsInner": { + "type_name": "PortConvertLayer3InputRequestIpsInner", + "description": "PortConvertLayer3InputRequestIpsInner struct for PortConvertLayer3InputRequestIpsInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AddressFamily": { + "name": "AddressFamily", + "description": "", + "json_tag": "address_family" + }, + "Public": { + "name": "Public", + "description": "", + "json_tag": "public" + } + } + }, + "PortData": { + "type_name": "PortData", + "description": "PortData struct for PortData", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bonded": { + "name": "Bonded", + "description": "Bonded is true for NetworkPort ports in a bond and NetworkBondPort ports that are active", + "json_tag": "bonded" + }, + "Mac": { + "name": "Mac", + "description": "MAC address is set for NetworkPort ports", + "json_tag": "mac" + } + } + }, + "PortVlanAssignment": { + "type_name": "PortVlanAssignment", + "description": "PortVlanAssignment struct for PortVlanAssignment", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Native": { + "name": "Native", + "description": "", + "json_tag": "native" + }, + "Port": { + "name": "Port", + "description": "", + "json_tag": "port" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "VirtualNetwork": { + "name": "VirtualNetwork", + "description": "", + "json_tag": "virtual_network" + }, + "Vlan": { + "name": "Vlan", + "description": "", + "json_tag": "vlan" + } + } + }, + "PortVlanAssignmentBatch": { + "type_name": "PortVlanAssignmentBatch", + "description": "PortVlanAssignmentBatch struct for PortVlanAssignmentBatch", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "ErrorMessages": { + "name": "ErrorMessages", + "description": "", + "json_tag": "error_messages" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Port": { + "name": "Port", + "description": "", + "json_tag": "port" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Quantity": { + "name": "Quantity", + "description": "", + "json_tag": "quantity" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "VlanAssignments": { + "name": "VlanAssignments", + "description": "", + "json_tag": "vlan_assignments" + } + } + }, + "PortVlanAssignmentBatchCreateInput": { + "type_name": "PortVlanAssignmentBatchCreateInput", + "description": "PortVlanAssignmentBatchCreateInput struct for PortVlanAssignmentBatchCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "VlanAssignments": { + "name": "VlanAssignments", + "description": "", + "json_tag": "vlan_assignments" + } + } + }, + "PortVlanAssignmentBatchCreateInputVlanAssignmentsInner": { + "type_name": "PortVlanAssignmentBatchCreateInputVlanAssignmentsInner", + "description": "PortVlanAssignmentBatchCreateInputVlanAssignmentsInner struct for PortVlanAssignmentBatchCreateInputVlanAssignmentsInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Native": { + "name": "Native", + "description": "", + "json_tag": "native" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Vlan": { + "name": "Vlan", + "description": "", + "json_tag": "vlan" + } + } + }, + "PortVlanAssignmentBatchList": { + "type_name": "PortVlanAssignmentBatchList", + "description": "PortVlanAssignmentBatchList struct for PortVlanAssignmentBatchList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Batches": { + "name": "Batches", + "description": "", + "json_tag": "batches" + } + } + }, + "PortVlanAssignmentBatchVlanAssignmentsInner": { + "type_name": "PortVlanAssignmentBatchVlanAssignmentsInner", + "description": "PortVlanAssignmentBatchVlanAssignmentsInner struct for PortVlanAssignmentBatchVlanAssignmentsInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Native": { + "name": "Native", + "description": "", + "json_tag": "native" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Vlan": { + "name": "Vlan", + "description": "", + "json_tag": "vlan" + } + } + }, + "PortVlanAssignmentList": { + "type_name": "PortVlanAssignmentList", + "description": "PortVlanAssignmentList struct for PortVlanAssignmentList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "VlanAssignments": { + "name": "VlanAssignments", + "description": "", + "json_tag": "vlan_assignments" + } + } + }, + "Project": { + "type_name": "Project", + "description": "Project struct for Project", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BackendTransferEnabled": { + "name": "BackendTransferEnabled", + "description": "", + "json_tag": "backend_transfer_enabled" + }, + "BgpConfig": { + "name": "BgpConfig", + "description": "", + "json_tag": "bgp_config" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Devices": { + "name": "Devices", + "description": "", + "json_tag": "devices" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Invitations": { + "name": "Invitations", + "description": "", + "json_tag": "invitations" + }, + "MaxDevices": { + "name": "MaxDevices", + "description": "", + "json_tag": "max_devices" + }, + "Members": { + "name": "Members", + "description": "", + "json_tag": "members" + }, + "Memberships": { + "name": "Memberships", + "description": "", + "json_tag": "memberships" + }, + "Name": { + "name": "Name", + "description": "The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis.", + "json_tag": "name" + }, + "NetworkStatus": { + "name": "NetworkStatus", + "description": "", + "json_tag": "network_status" + }, + "Organization": { + "name": "Organization", + "description": "", + "json_tag": "organization" + }, + "PaymentMethod": { + "name": "PaymentMethod", + "description": "", + "json_tag": "payment_method" + }, + "SshKeys": { + "name": "SshKeys", + "description": "", + "json_tag": "ssh_keys" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "Url": { + "name": "Url", + "description": "", + "json_tag": "url" + }, + "Volumes": { + "name": "Volumes", + "description": "", + "json_tag": "volumes" + } + } + }, + "ProjectCreateFromRootInput": { + "type_name": "ProjectCreateFromRootInput", + "description": "ProjectCreateFromRootInput struct for ProjectCreateFromRootInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Name": { + "name": "Name", + "description": "The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis.", + "json_tag": "name" + }, + "OrganizationId": { + "name": "OrganizationId", + "description": "", + "json_tag": "organization_id" + }, + "PaymentMethodId": { + "name": "PaymentMethodId", + "description": "", + "json_tag": "payment_method_id" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ProjectCreateInput": { + "type_name": "ProjectCreateInput", + "description": "ProjectCreateInput struct for ProjectCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Name": { + "name": "Name", + "description": "The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis.", + "json_tag": "name" + }, + "PaymentMethodId": { + "name": "PaymentMethodId", + "description": "", + "json_tag": "payment_method_id" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ProjectIdName": { + "type_name": "ProjectIdName", + "description": "ProjectIdName struct for ProjectIdName", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "ProjectList": { + "type_name": "ProjectList", + "description": "ProjectList struct for ProjectList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + }, + "Projects": { + "name": "Projects", + "description": "", + "json_tag": "projects" + } + } + }, + "ProjectUpdateInput": { + "type_name": "ProjectUpdateInput", + "description": "ProjectUpdateInput struct for ProjectUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BackendTransferEnabled": { + "name": "BackendTransferEnabled", + "description": "", + "json_tag": "backend_transfer_enabled" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Name": { + "name": "Name", + "description": "The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis.", + "json_tag": "name" + }, + "PaymentMethodId": { + "name": "PaymentMethodId", + "description": "", + "json_tag": "payment_method_id" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "ProjectUsage": { + "type_name": "ProjectUsage", + "description": "ProjectUsage struct for ProjectUsage", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Facility": { + "name": "Facility", + "description": "", + "json_tag": "facility" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Plan": { + "name": "Plan", + "description": "", + "json_tag": "plan" + }, + "PlanVersion": { + "name": "PlanVersion", + "description": "", + "json_tag": "plan_version" + }, + "Price": { + "name": "Price", + "description": "", + "json_tag": "price" + }, + "Quantity": { + "name": "Quantity", + "description": "", + "json_tag": "quantity" + }, + "Total": { + "name": "Total", + "description": "", + "json_tag": "total" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Unit": { + "name": "Unit", + "description": "", + "json_tag": "unit" + } + } + }, + "ProjectUsageList": { + "type_name": "ProjectUsageList", + "description": "ProjectUsageList struct for ProjectUsageList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Usages": { + "name": "Usages", + "description": "", + "json_tag": "usages" + } + } + }, + "Raid": { + "type_name": "Raid", + "description": "Raid struct for Raid", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Devices": { + "name": "Devices", + "description": "", + "json_tag": "devices" + }, + "Level": { + "name": "Level", + "description": "", + "json_tag": "level" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "RequestIPReservation201Response": { + "type_name": "RequestIPReservation201Response", + "description": "RequestIPReservation201Response - struct for RequestIPReservation201Response", + "fields": { + "IPReservation": { + "name": "IPReservation", + "description": "" + }, + "VrfIpReservation": { + "name": "VrfIpReservation", + "description": "" + } + } + }, + "RequestIPReservationRequest": { + "type_name": "RequestIPReservationRequest", + "description": "RequestIPReservationRequest - struct for RequestIPReservationRequest", + "fields": { + "IPReservationRequestInput": { + "name": "IPReservationRequestInput", + "description": "" + }, + "VrfIpReservationCreateInput": { + "name": "VrfIpReservationCreateInput", + "description": "" + } + } + }, + "SSHKey": { + "type_name": "SSHKey", + "description": "SSHKey struct for SSHKey", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Entity": { + "name": "Entity", + "description": "", + "json_tag": "entity" + }, + "Fingerprint": { + "name": "Fingerprint", + "description": "", + "json_tag": "fingerprint" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Key": { + "name": "Key", + "description": "", + "json_tag": "key" + }, + "Label": { + "name": "Label", + "description": "", + "json_tag": "label" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + } + } + }, + "SSHKeyCreateInput": { + "type_name": "SSHKeyCreateInput", + "description": "SSHKeyCreateInput struct for SSHKeyCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "InstancesIds": { + "name": "InstancesIds", + "description": "List of instance UUIDs to associate SSH key with, when empty array is sent all instances belonging to entity will be included", + "json_tag": "instances_ids" + }, + "Key": { + "name": "Key", + "description": "", + "json_tag": "key" + }, + "Label": { + "name": "Label", + "description": "", + "json_tag": "label" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "SSHKeyInput": { + "type_name": "SSHKeyInput", + "description": "SSHKeyInput struct for SSHKeyInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Key": { + "name": "Key", + "description": "", + "json_tag": "key" + }, + "Label": { + "name": "Label", + "description": "", + "json_tag": "label" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "SSHKeyList": { + "type_name": "SSHKeyList", + "description": "SSHKeyList struct for SSHKeyList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "SshKeys": { + "name": "SshKeys", + "description": "", + "json_tag": "ssh_keys" + } + } + }, + "SelfServiceReservationItemRequest": { + "type_name": "SelfServiceReservationItemRequest", + "description": "SelfServiceReservationItemRequest struct for SelfServiceReservationItemRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "MetroId": { + "name": "MetroId", + "description": "Metro ID of the item.", + "json_tag": "metro_id" + }, + "PlanId": { + "name": "PlanId", + "description": "Plan ID of the item.", + "json_tag": "plan_id" + }, + "Quantity": { + "name": "Quantity", + "description": "Number of items.", + "json_tag": "quantity" + }, + "Term": { + "name": "Term", + "description": "Contract term of the item.", + "json_tag": "term" + } + } + }, + "SelfServiceReservationItemResponse": { + "type_name": "SelfServiceReservationItemResponse", + "description": "SelfServiceReservationItemResponse struct for SelfServiceReservationItemResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Amount": { + "name": "Amount", + "description": "", + "json_tag": "amount" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "MetroCode": { + "name": "MetroCode", + "description": "", + "json_tag": "metro_code" + }, + "MetroId": { + "name": "MetroId", + "description": "", + "json_tag": "metro_id" + }, + "MetroName": { + "name": "MetroName", + "description": "", + "json_tag": "metro_name" + }, + "Plan": { + "name": "Plan", + "description": "", + "json_tag": "plan" + }, + "PlanCategories": { + "name": "PlanCategories", + "description": "", + "json_tag": "plan_categories" + }, + "PlanId": { + "name": "PlanId", + "description": "", + "json_tag": "plan_id" + }, + "PlanName": { + "name": "PlanName", + "description": "", + "json_tag": "plan_name" + }, + "PlanSlug": { + "name": "PlanSlug", + "description": "", + "json_tag": "plan_slug" + }, + "Quantity": { + "name": "Quantity", + "description": "", + "json_tag": "quantity" + }, + "Term": { + "name": "Term", + "description": "", + "json_tag": "term" + } + } + }, + "SelfServiceReservationList": { + "type_name": "SelfServiceReservationList", + "description": "SelfServiceReservationList struct for SelfServiceReservationList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Reservations": { + "name": "Reservations", + "description": "", + "json_tag": "reservations" + } + } + }, + "SelfServiceReservationResponse": { + "type_name": "SelfServiceReservationResponse", + "description": "SelfServiceReservationResponse struct for SelfServiceReservationResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Item": { + "name": "Item", + "description": "", + "json_tag": "item" + }, + "Notes": { + "name": "Notes", + "description": "", + "json_tag": "notes" + }, + "Organization": { + "name": "Organization", + "description": "", + "json_tag": "organization" + }, + "OrganizationId": { + "name": "OrganizationId", + "description": "", + "json_tag": "organization_id" + }, + "Period": { + "name": "Period", + "description": "", + "json_tag": "period" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "ProjectId": { + "name": "ProjectId", + "description": "", + "json_tag": "project_id" + }, + "StartDate": { + "name": "StartDate", + "description": "", + "json_tag": "start_date" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "TotalCost": { + "name": "TotalCost", + "description": "", + "json_tag": "total_cost" + } + } + }, + "ServerConfiguration": { + "type_name": "ServerConfiguration", + "description": "ServerConfiguration stores the information about a server", + "fields": { + "Description": { + "name": "Description", + "description": "" + }, + "URL": { + "name": "URL", + "description": "" + }, + "Variables": { + "name": "Variables", + "description": "" + } + } + }, + "ServerInfo": { + "type_name": "ServerInfo", + "description": "ServerInfo struct for ServerInfo", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Facility": { + "name": "Facility", + "description": "Deprecated", + "json_tag": "facility" + }, + "Metro": { + "name": "Metro", + "description": "The metro ID or code to check the capacity in.", + "json_tag": "metro" + }, + "Plan": { + "name": "Plan", + "description": "The plan ID or slug to check the capacity of.", + "json_tag": "plan" + }, + "Quantity": { + "name": "Quantity", + "description": "The number of servers to check the capacity of.", + "json_tag": "quantity" + } + } + }, + "ServerVariable": { + "type_name": "ServerVariable", + "description": "ServerVariable stores the information about a server variable", + "fields": { + "DefaultValue": { + "name": "DefaultValue", + "description": "" + }, + "Description": { + "name": "Description", + "description": "" + }, + "EnumValues": { + "name": "EnumValues", + "description": "" + } + } + }, + "SharedPortVCVlanCreateInput": { + "type_name": "SharedPortVCVlanCreateInput", + "description": "SharedPortVCVlanCreateInput struct for SharedPortVCVlanCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ContactEmail": { + "name": "ContactEmail", + "description": "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.", + "json_tag": "contact_email" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Metro": { + "name": "Metro", + "description": "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.", + "json_tag": "metro" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Speed": { + "name": "Speed", + "description": "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.", + "json_tag": "speed" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Vlans": { + "name": "Vlans", + "description": "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_tag": "vlans" + } + } + }, + "SpotMarketPricesList": { + "type_name": "SpotMarketPricesList", + "description": "SpotMarketPricesList struct for SpotMarketPricesList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "SpotMarketPrices": { + "name": "SpotMarketPrices", + "description": "", + "json_tag": "spot_market_prices" + } + } + }, + "SpotMarketPricesPerMetroList": { + "type_name": "SpotMarketPricesPerMetroList", + "description": "SpotMarketPricesPerMetroList struct for SpotMarketPricesPerMetroList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "SpotMarketPrices": { + "name": "SpotMarketPrices", + "description": "", + "json_tag": "spot_market_prices" + } + } + }, + "SpotMarketPricesPerMetroReport": { + "type_name": "SpotMarketPricesPerMetroReport", + "description": "SpotMarketPricesPerMetroReport struct for SpotMarketPricesPerMetroReport", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Am": { + "name": "Am", + "description": "", + "json_tag": "am" + }, + "Ch": { + "name": "Ch", + "description": "", + "json_tag": "ch" + }, + "Da": { + "name": "Da", + "description": "", + "json_tag": "da" + }, + "La": { + "name": "La", + "description": "", + "json_tag": "la" + }, + "Ny": { + "name": "Ny", + "description": "", + "json_tag": "ny" + }, + "Sg": { + "name": "Sg", + "description": "", + "json_tag": "sg" + }, + "Sv": { + "name": "Sv", + "description": "", + "json_tag": "sv" + } + } + }, + "SpotMarketRequest": { + "type_name": "SpotMarketRequest", + "description": "SpotMarketRequest struct for SpotMarketRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "DevicesMax": { + "name": "DevicesMax", + "description": "", + "json_tag": "devices_max" + }, + "DevicesMin": { + "name": "DevicesMin", + "description": "", + "json_tag": "devices_min" + }, + "EndAt": { + "name": "EndAt", + "description": "", + "json_tag": "end_at" + }, + "Facilities": { + "name": "Facilities", + "description": "", + "json_tag": "facilities" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Instances": { + "name": "Instances", + "description": "", + "json_tag": "instances" + }, + "MaxBidPrice": { + "name": "MaxBidPrice", + "description": "", + "json_tag": "max_bid_price" + }, + "Metro": { + "name": "Metro", + "description": "", + "json_tag": "metro" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + } + } + }, + "SpotMarketRequestCreateInput": { + "type_name": "SpotMarketRequestCreateInput", + "description": "SpotMarketRequestCreateInput struct for SpotMarketRequestCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DevicesMax": { + "name": "DevicesMax", + "description": "", + "json_tag": "devices_max" + }, + "DevicesMin": { + "name": "DevicesMin", + "description": "", + "json_tag": "devices_min" + }, + "EndAt": { + "name": "EndAt", + "description": "", + "json_tag": "end_at" + }, + "Facilities": { + "name": "Facilities", + "description": "Deprecated", + "json_tag": "facilities" + }, + "InstanceParameters": { + "name": "InstanceParameters", + "description": "", + "json_tag": "instance_parameters" + }, + "MaxBidPrice": { + "name": "MaxBidPrice", + "description": "", + "json_tag": "max_bid_price" + }, + "Metro": { + "name": "Metro", + "description": "The metro ID or code the spot market request will be created in.", + "json_tag": "metro" + } + } + }, + "SpotMarketRequestCreateInputInstanceParameters": { + "type_name": "SpotMarketRequestCreateInputInstanceParameters", + "description": "SpotMarketRequestCreateInputInstanceParameters struct for SpotMarketRequestCreateInputInstanceParameters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AlwaysPxe": { + "name": "AlwaysPxe", + "description": "", + "json_tag": "always_pxe" + }, + "BillingCycle": { + "name": "BillingCycle", + "description": "", + "json_tag": "billing_cycle" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Features": { + "name": "Features", + "description": "", + "json_tag": "features" + }, + "Hostname": { + "name": "Hostname", + "description": "", + "json_tag": "hostname" + }, + "Hostnames": { + "name": "Hostnames", + "description": "", + "json_tag": "hostnames" + }, + "Locked": { + "name": "Locked", + "description": "Whether the device should be locked, preventing accidental deletion.", + "json_tag": "locked" + }, + "NoSshKeys": { + "name": "NoSshKeys", + "description": "", + "json_tag": "no_ssh_keys" + }, + "OperatingSystem": { + "name": "OperatingSystem", + "description": "", + "json_tag": "operating_system" + }, + "Plan": { + "name": "Plan", + "description": "", + "json_tag": "plan" + }, + "PrivateIpv4SubnetSize": { + "name": "PrivateIpv4SubnetSize", + "description": "", + "json_tag": "private_ipv4_subnet_size" + }, + "ProjectSshKeys": { + "name": "ProjectSshKeys", + "description": "", + "json_tag": "project_ssh_keys" + }, + "PublicIpv4SubnetSize": { + "name": "PublicIpv4SubnetSize", + "description": "", + "json_tag": "public_ipv4_subnet_size" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "TerminationTime": { + "name": "TerminationTime", + "description": "", + "json_tag": "termination_time" + }, + "UserSshKeys": { + "name": "UserSshKeys", + "description": "The UUIDs of users whose SSH keys should be included on the provisioned device.", + "json_tag": "user_ssh_keys" + }, + "Userdata": { + "name": "Userdata", + "description": "", + "json_tag": "userdata" + } + } + }, + "SpotMarketRequestList": { + "type_name": "SpotMarketRequestList", + "description": "SpotMarketRequestList struct for SpotMarketRequestList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "SpotMarketRequests": { + "name": "SpotMarketRequests", + "description": "", + "json_tag": "spot_market_requests" + } + } + }, + "SpotMarketRequestMetro": { + "type_name": "SpotMarketRequestMetro", + "description": "SpotMarketRequestMetro struct for SpotMarketRequestMetro", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Code": { + "name": "Code", + "description": "", + "json_tag": "code" + }, + "Country": { + "name": "Country", + "description": "", + "json_tag": "country" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "SpotPricesDatapoints": { + "type_name": "SpotPricesDatapoints", + "description": "SpotPricesDatapoints struct for SpotPricesDatapoints", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Datapoints": { + "name": "Datapoints", + "description": "", + "json_tag": "datapoints" + } + } + }, + "SpotPricesHistoryReport": { + "type_name": "SpotPricesHistoryReport", + "description": "SpotPricesHistoryReport struct for SpotPricesHistoryReport", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "PricesHistory": { + "name": "PricesHistory", + "description": "", + "json_tag": "prices_history" + } + } + }, + "SpotPricesPerBaremetal": { + "type_name": "SpotPricesPerBaremetal", + "description": "SpotPricesPerBaremetal struct for SpotPricesPerBaremetal", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Price": { + "name": "Price", + "description": "", + "json_tag": "price" + } + } + }, + "SpotPricesPerFacility": { + "type_name": "SpotPricesPerFacility", + "description": "SpotPricesPerFacility struct for SpotPricesPerFacility", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Baremetal0": { + "name": "Baremetal0", + "description": "", + "json_tag": "baremetal_0" + }, + "Baremetal1": { + "name": "Baremetal1", + "description": "", + "json_tag": "baremetal_1" + }, + "Baremetal2": { + "name": "Baremetal2", + "description": "", + "json_tag": "baremetal_2" + }, + "Baremetal2a": { + "name": "Baremetal2a", + "description": "", + "json_tag": "baremetal_2a" + }, + "Baremetal2a2": { + "name": "Baremetal2a2", + "description": "", + "json_tag": "baremetal_2a2" + }, + "Baremetal3": { + "name": "Baremetal3", + "description": "", + "json_tag": "baremetal_3" + }, + "BaremetalS": { + "name": "BaremetalS", + "description": "", + "json_tag": "baremetal_s" + }, + "C2MediumX86": { + "name": "C2MediumX86", + "description": "", + "json_tag": "c2.medium.x86" + }, + "M2XlargeX86": { + "name": "M2XlargeX86", + "description": "", + "json_tag": "m2.xlarge.x86" + } + } + }, + "SpotPricesPerNewFacility": { + "type_name": "SpotPricesPerNewFacility", + "description": "SpotPricesPerNewFacility struct for SpotPricesPerNewFacility", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Baremetal1e": { + "name": "Baremetal1e", + "description": "", + "json_tag": "baremetal_1e" + } + } + }, + "SpotPricesReport": { + "type_name": "SpotPricesReport", + "description": "SpotPricesReport struct for SpotPricesReport", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Ams1": { + "name": "Ams1", + "description": "", + "json_tag": "ams1" + }, + "Atl1": { + "name": "Atl1", + "description": "", + "json_tag": "atl1" + }, + "Dfw1": { + "name": "Dfw1", + "description": "", + "json_tag": "dfw1" + }, + "Ewr1": { + "name": "Ewr1", + "description": "", + "json_tag": "ewr1" + }, + "Fra1": { + "name": "Fra1", + "description": "", + "json_tag": "fra1" + }, + "Iad1": { + "name": "Iad1", + "description": "", + "json_tag": "iad1" + }, + "Lax1": { + "name": "Lax1", + "description": "", + "json_tag": "lax1" + }, + "Nrt1": { + "name": "Nrt1", + "description": "", + "json_tag": "nrt1" + }, + "Ord1": { + "name": "Ord1", + "description": "", + "json_tag": "ord1" + }, + "Sea1": { + "name": "Sea1", + "description": "", + "json_tag": "sea1" + }, + "Sin1": { + "name": "Sin1", + "description": "", + "json_tag": "sin1" + }, + "Sjc1": { + "name": "Sjc1", + "description": "", + "json_tag": "sjc1" + }, + "Syd1": { + "name": "Syd1", + "description": "", + "json_tag": "syd1" + }, + "Yyz1": { + "name": "Yyz1", + "description": "", + "json_tag": "yyz1" + } + } + }, + "Storage": { + "type_name": "Storage", + "description": "Storage struct for Storage", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Disks": { + "name": "Disks", + "description": "", + "json_tag": "disks" + }, + "Filesystems": { + "name": "Filesystems", + "description": "", + "json_tag": "filesystems" + }, + "Raid": { + "name": "Raid", + "description": "", + "json_tag": "raid" + } + } + }, + "SupportRequestInput": { + "type_name": "SupportRequestInput", + "description": "SupportRequestInput struct for SupportRequestInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeviceId": { + "name": "DeviceId", + "description": "", + "json_tag": "device_id" + }, + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "Priority": { + "name": "Priority", + "description": "", + "json_tag": "priority" + }, + "ProjectId": { + "name": "ProjectId", + "description": "", + "json_tag": "project_id" + }, + "Subject": { + "name": "Subject", + "description": "", + "json_tag": "subject" + } + } + }, + "TransferRequest": { + "type_name": "TransferRequest", + "description": "TransferRequest struct for TransferRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "TargetOrganization": { + "name": "TargetOrganization", + "description": "", + "json_tag": "target_organization" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + } + } + }, + "TransferRequestInput": { + "type_name": "TransferRequestInput", + "description": "TransferRequestInput struct for TransferRequestInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "TargetOrganizationId": { + "name": "TargetOrganizationId", + "description": "", + "json_tag": "target_organization_id" + } + } + }, + "TransferRequestList": { + "type_name": "TransferRequestList", + "description": "TransferRequestList struct for TransferRequestList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Transfers": { + "name": "Transfers", + "description": "", + "json_tag": "transfers" + } + } + }, + "UpdateEmailInput": { + "type_name": "UpdateEmailInput", + "description": "UpdateEmailInput struct for UpdateEmailInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Default": { + "name": "Default", + "description": "", + "json_tag": "default" + } + } + }, + "User": { + "type_name": "User", + "description": "User struct for User", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AvatarThumbUrl": { + "name": "AvatarThumbUrl", + "description": "", + "json_tag": "avatar_thumb_url" + }, + "AvatarUrl": { + "name": "AvatarUrl", + "description": "", + "json_tag": "avatar_url" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "DefaultOrganizationId": { + "name": "DefaultOrganizationId", + "description": "", + "json_tag": "default_organization_id" + }, + "DefaultProjectId": { + "name": "DefaultProjectId", + "description": "", + "json_tag": "default_project_id" + }, + "Email": { + "name": "Email", + "description": "", + "json_tag": "email" + }, + "Emails": { + "name": "Emails", + "description": "", + "json_tag": "emails" + }, + "FirstName": { + "name": "FirstName", + "description": "", + "json_tag": "first_name" + }, + "FraudScore": { + "name": "FraudScore", + "description": "", + "json_tag": "fraud_score" + }, + "FullName": { + "name": "FullName", + "description": "", + "json_tag": "full_name" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "LastLoginAt": { + "name": "LastLoginAt", + "description": "", + "json_tag": "last_login_at" + }, + "LastName": { + "name": "LastName", + "description": "", + "json_tag": "last_name" + }, + "MaxOrganizations": { + "name": "MaxOrganizations", + "description": "", + "json_tag": "max_organizations" + }, + "MaxProjects": { + "name": "MaxProjects", + "description": "", + "json_tag": "max_projects" + }, + "PhoneNumber": { + "name": "PhoneNumber", + "description": "", + "json_tag": "phone_number" + }, + "ShortId": { + "name": "ShortId", + "description": "", + "json_tag": "short_id" + }, + "Timezone": { + "name": "Timezone", + "description": "", + "json_tag": "timezone" + }, + "TwoFactorAuth": { + "name": "TwoFactorAuth", + "description": "", + "json_tag": "two_factor_auth" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + } + } + }, + "UserCreateInput": { + "type_name": "UserCreateInput", + "description": "UserCreateInput struct for UserCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CompanyName": { + "name": "CompanyName", + "description": "", + "json_tag": "company_name" + }, + "CompanyUrl": { + "name": "CompanyUrl", + "description": "", + "json_tag": "company_url" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Emails": { + "name": "Emails", + "description": "", + "json_tag": "emails" + }, + "FirstName": { + "name": "FirstName", + "description": "", + "json_tag": "first_name" + }, + "InvitationId": { + "name": "InvitationId", + "description": "", + "json_tag": "invitation_id" + }, + "LastName": { + "name": "LastName", + "description": "", + "json_tag": "last_name" + }, + "Level": { + "name": "Level", + "description": "", + "json_tag": "level" + }, + "Nonce": { + "name": "Nonce", + "description": "", + "json_tag": "nonce" + }, + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "PhoneNumber": { + "name": "PhoneNumber", + "description": "", + "json_tag": "phone_number" + }, + "SocialAccounts": { + "name": "SocialAccounts", + "description": "", + "json_tag": "social_accounts" + }, + "Timezone": { + "name": "Timezone", + "description": "", + "json_tag": "timezone" + }, + "Title": { + "name": "Title", + "description": "", + "json_tag": "title" + }, + "TwoFactorAuth": { + "name": "TwoFactorAuth", + "description": "", + "json_tag": "two_factor_auth" + }, + "VerifiedAt": { + "name": "VerifiedAt", + "description": "", + "json_tag": "verified_at" + } + } + }, + "UserLimited": { + "type_name": "UserLimited", + "description": "UserLimited struct for UserLimited", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AvatarThumbUrl": { + "name": "AvatarThumbUrl", + "description": "Avatar thumbnail URL of the User", + "json_tag": "avatar_thumb_url" + }, + "AvatarUrl": { + "name": "AvatarUrl", + "description": "Avatar URL of the User", + "json_tag": "avatar_url" + }, + "FullName": { + "name": "FullName", + "description": "Full name of the User", + "json_tag": "full_name" + }, + "Href": { + "name": "Href", + "description": "API URL uniquely representing the User", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "ID of the User", + "json_tag": "id" + } + } + }, + "UserList": { + "type_name": "UserList", + "description": "UserList struct for UserList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + }, + "Users": { + "name": "Users", + "description": "", + "json_tag": "users" + } + } + }, + "UserLite": { + "type_name": "UserLite", + "description": "UserLite struct for UserLite", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AvatarThumbUrl": { + "name": "AvatarThumbUrl", + "description": "Avatar thumbnail URL of the User", + "json_tag": "avatar_thumb_url" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "When the user was created", + "json_tag": "created_at" + }, + "Email": { + "name": "Email", + "description": "Primary email address of the User", + "json_tag": "email" + }, + "FirstName": { + "name": "FirstName", + "description": "First name of the User", + "json_tag": "first_name" + }, + "FullName": { + "name": "FullName", + "description": "Full name of the User", + "json_tag": "full_name" + }, + "Href": { + "name": "Href", + "description": "API URL uniquely representing the User", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "ID of the User", + "json_tag": "id" + }, + "LastName": { + "name": "LastName", + "description": "Last name of the User", + "json_tag": "last_name" + }, + "ShortId": { + "name": "ShortId", + "description": "Short ID of the User", + "json_tag": "short_id" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "When the user details were last updated", + "json_tag": "updated_at" + } + } + }, + "UserUpdateInput": { + "type_name": "UserUpdateInput", + "description": "UserUpdateInput struct for UserUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "FirstName": { + "name": "FirstName", + "description": "", + "json_tag": "first_name" + }, + "LastName": { + "name": "LastName", + "description": "", + "json_tag": "last_name" + }, + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "PhoneNumber": { + "name": "PhoneNumber", + "description": "", + "json_tag": "phone_number" + }, + "Timezone": { + "name": "Timezone", + "description": "", + "json_tag": "timezone" + } + } + }, + "Userdata": { + "type_name": "Userdata", + "description": "Userdata struct for Userdata", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Userdata": { + "name": "Userdata", + "description": "", + "json_tag": "userdata" + } + } + }, + "VerifyEmail": { + "type_name": "VerifyEmail", + "description": "VerifyEmail struct for VerifyEmail", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "UserToken": { + "name": "UserToken", + "description": "User verification token", + "json_tag": "user_token" + } + } + }, + "VirtualCircuit": { + "type_name": "VirtualCircuit", + "description": "VirtualCircuit - struct for VirtualCircuit", + "fields": { + "VlanVirtualCircuit": { + "name": "VlanVirtualCircuit", + "description": "" + }, + "VrfVirtualCircuit": { + "name": "VrfVirtualCircuit", + "description": "" + } + } + }, + "VirtualCircuitCreateInput": { + "type_name": "VirtualCircuitCreateInput", + "description": "VirtualCircuitCreateInput - struct for VirtualCircuitCreateInput", + "fields": { + "VlanVirtualCircuitCreateInput": { + "name": "VlanVirtualCircuitCreateInput", + "description": "" + }, + "VrfVirtualCircuitCreateInput": { + "name": "VrfVirtualCircuitCreateInput", + "description": "" + } + } + }, + "VirtualCircuitList": { + "type_name": "VirtualCircuitList", + "description": "VirtualCircuitList struct for VirtualCircuitList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "VirtualCircuits": { + "name": "VirtualCircuits", + "description": "", + "json_tag": "virtual_circuits" + } + } + }, + "VirtualCircuitUpdateInput": { + "type_name": "VirtualCircuitUpdateInput", + "description": "VirtualCircuitUpdateInput - struct for VirtualCircuitUpdateInput", + "fields": { + "VlanVirtualCircuitUpdateInput": { + "name": "VlanVirtualCircuitUpdateInput", + "description": "" + }, + "VrfVirtualCircuitUpdateInput": { + "name": "VrfVirtualCircuitUpdateInput", + "description": "" + } + } + }, + "VirtualNetwork": { + "type_name": "VirtualNetwork", + "description": "VirtualNetwork struct for VirtualNetwork", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "AssignedTo": { + "name": "AssignedTo", + "description": "", + "json_tag": "assigned_to" + }, + "AssignedToVirtualCircuit": { + "name": "AssignedToVirtualCircuit", + "description": "True if the virtual network is attached to a virtual circuit. False if not.", + "json_tag": "assigned_to_virtual_circuit" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Facility": { + "name": "Facility", + "description": "", + "json_tag": "facility" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Instances": { + "name": "Instances", + "description": "A list of instances with ports currently associated to this Virtual Network.", + "json_tag": "instances" + }, + "MetalGateways": { + "name": "MetalGateways", + "description": "A list of metal gateways currently associated to this Virtual Network.", + "json_tag": "metal_gateways" + }, + "Metro": { + "name": "Metro", + "description": "", + "json_tag": "metro" + }, + "MetroCode": { + "name": "MetroCode", + "description": "The Metro code of the metro in which this Virtual Network is defined.", + "json_tag": "metro_code" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Vxlan": { + "name": "Vxlan", + "description": "", + "json_tag": "vxlan" + } + } + }, + "VirtualNetworkCreateInput": { + "type_name": "VirtualNetworkCreateInput", + "description": "VirtualNetworkCreateInput struct for VirtualNetworkCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Facility": { + "name": "Facility", + "description": "The UUID (or facility code) for the Facility in which to create this Virtual network.\nDeprecated", + "json_tag": "facility" + }, + "Metro": { + "name": "Metro", + "description": "The UUID (or metro code) for the Metro in which to create this Virtual Network.", + "json_tag": "metro" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Vxlan": { + "name": "Vxlan", + "description": "VLAN ID between 2-3999. Must be unique for the project within the Metro in which this Virtual Network is being created. If no value is specified, the next-available VLAN ID in the range 1000-1999 will be automatically selected.", + "json_tag": "vxlan" + } + } + }, + "VirtualNetworkList": { + "type_name": "VirtualNetworkList", + "description": "VirtualNetworkList struct for VirtualNetworkList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "VirtualNetworks": { + "name": "VirtualNetworks", + "description": "", + "json_tag": "virtual_networks" + } + } + }, + "VirtualNetworkUpdateInput": { + "type_name": "VirtualNetworkUpdateInput", + "description": "VirtualNetworkUpdateInput struct for VirtualNetworkUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "VlanCSPConnectionCreateInput": { + "type_name": "VlanCSPConnectionCreateInput", + "description": "VlanCSPConnectionCreateInput struct for VlanCSPConnectionCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ContactEmail": { + "name": "ContactEmail", + "description": "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.", + "json_tag": "contact_email" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "FabricProvider": { + "name": "FabricProvider", + "description": "", + "json_tag": "fabric_provider" + }, + "Metro": { + "name": "Metro", + "description": "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.", + "json_tag": "metro" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Speed": { + "name": "Speed", + "description": "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.", + "json_tag": "speed" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Vlans": { + "name": "Vlans", + "description": "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_tag": "vlans" + } + } + }, + "VlanCSPConnectionCreateInputFabricProvider": { + "type_name": "VlanCSPConnectionCreateInputFabricProvider", + "description": "VlanCSPConnectionCreateInputFabricProvider - Configuration information for connecting to external cloud service provider.", + "fields": { + "AWSFabricProvider": { + "name": "AWSFabricProvider", + "description": "" + } + } + }, + "VlanFabricVcCreateInput": { + "type_name": "VlanFabricVcCreateInput", + "description": "VlanFabricVcCreateInput struct for VlanFabricVcCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ContactEmail": { + "name": "ContactEmail", + "description": "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.", + "json_tag": "contact_email" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "FacilityId": { + "name": "FacilityId", + "description": "", + "json_tag": "facility_id" + }, + "Metro": { + "name": "Metro", + "description": "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.", + "json_tag": "metro" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Redundancy": { + "name": "Redundancy", + "description": "Either 'primary' or 'redundant'.", + "json_tag": "redundancy" + }, + "ServiceTokenType": { + "name": "ServiceTokenType", + "description": "", + "json_tag": "service_token_type" + }, + "Speed": { + "name": "Speed", + "description": "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.", + "json_tag": "speed" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Vlans": { + "name": "Vlans", + "description": "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_tag": "vlans" + } + } + }, + "VlanVirtualCircuit": { + "type_name": "VlanVirtualCircuit", + "description": "VlanVirtualCircuit struct for VlanVirtualCircuit", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Bill": { + "name": "Bill", + "description": "True if the Virtual Circuit is being billed. Currently, only Virtual Circuits of Fabric VCs (Metal Billed) will be billed. Usage will start the first time the Virtual Circuit becomes active, and will not stop until it is deleted from Metal.", + "json_tag": "bill" + }, + "BillType": { + "name": "BillType", + "description": "", + "json_tag": "bill_type" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "NniVlan": { + "name": "NniVlan", + "description": "", + "json_tag": "nni_vlan" + }, + "Port": { + "name": "Port", + "description": "", + "json_tag": "port" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "ProviderConnectionId": { + "name": "ProviderConnectionId", + "description": "This field is relevant if using the `shared_port_vlan_to_csp` interconnection type. Once activated on the CSP, this field should contain the resource name that the virtual circuit is connected to on the provider's end.", + "json_tag": "provider_connection_id" + }, + "Speed": { + "name": "Speed", + "description": "For Virtual Circuits on shared and dedicated connections, this speed should match the one set on their Interconnection Ports. For Virtual Circuits on Fabric VCs (both Metal and Fabric Billed) that have found their corresponding Fabric connection, this is the actual speed of the interconnection that was configured when setting up the interconnection on the Fabric Portal. Details on Fabric VCs are included in the specification as a developer preview and is generally unavailable. Please contact our Support team for more details.", + "json_tag": "speed" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "VirtualNetwork": { + "name": "VirtualNetwork", + "description": "", + "json_tag": "virtual_network" + }, + "Vnid": { + "name": "Vnid", + "description": "", + "json_tag": "vnid" + } + } + }, + "VlanVirtualCircuitCreateInput": { + "type_name": "VlanVirtualCircuitCreateInput", + "description": "VlanVirtualCircuitCreateInput struct for VlanVirtualCircuitCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "NniVlan": { + "name": "NniVlan", + "description": "", + "json_tag": "nni_vlan" + }, + "ProjectId": { + "name": "ProjectId", + "description": "", + "json_tag": "project_id" + }, + "Speed": { + "name": "Speed", + "description": "speed can be passed as integer number representing bps speed or string (e.g. '52m' or '100g' or '4 gbps')", + "json_tag": "speed" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Vnid": { + "name": "Vnid", + "description": "A Virtual Network record UUID or the VNID of a Metro Virtual Network in your project (sent as integer).", + "json_tag": "vnid" + } + } + }, + "VlanVirtualCircuitUpdateInput": { + "type_name": "VlanVirtualCircuitUpdateInput", + "description": "VlanVirtualCircuitUpdateInput struct for VlanVirtualCircuitUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Speed": { + "name": "Speed", + "description": "Speed can be changed only if it is an interconnection on a Dedicated Port", + "json_tag": "speed" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Vnid": { + "name": "Vnid", + "description": "A Virtual Network record UUID or the VNID of a Metro Virtual Network in your project.", + "json_tag": "vnid" + } + } + }, + "Vrf": { + "type_name": "Vrf", + "description": "Vrf struct for Vrf", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpDynamicNeighborsBfdEnabled": { + "name": "BgpDynamicNeighborsBfdEnabled", + "description": "Toggle BFD on dynamic bgp neighbors sessions", + "json_tag": "bgp_dynamic_neighbors_bfd_enabled" + }, + "BgpDynamicNeighborsEnabled": { + "name": "BgpDynamicNeighborsEnabled", + "description": "Toggle to enable the dynamic bgp neighbors feature on the VRF", + "json_tag": "bgp_dynamic_neighbors_enabled" + }, + "BgpDynamicNeighborsExportRouteMap": { + "name": "BgpDynamicNeighborsExportRouteMap", + "description": "Toggle to export the VRF route-map to the dynamic bgp neighbors", + "json_tag": "bgp_dynamic_neighbors_export_route_map" + }, + "Bill": { + "name": "Bill", + "description": "True if the VRF is being billed. Usage will start when the first VRF Virtual Circuit is active, and will only stop when the VRF has been deleted.", + "json_tag": "bill" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "", + "json_tag": "created_by" + }, + "Description": { + "name": "Description", + "description": "Optional field that can be set to describe the VRF", + "json_tag": "description" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "IpRanges": { + "name": "IpRanges", + "description": "A list of CIDR network addresses. Like [\\\"10.0.0.0/16\\\", \\\"2001:d78::/59\\\"].", + "json_tag": "ip_ranges" + }, + "LocalAsn": { + "name": "LocalAsn", + "description": "A 4-byte ASN associated with the VRF.", + "json_tag": "local_asn" + }, + "Metro": { + "name": "Metro", + "description": "", + "json_tag": "metro" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "VirtualCircuits": { + "name": "VirtualCircuits", + "description": "Virtual circuits that are in the VRF", + "json_tag": "virtual_circuits" + } + } + }, + "VrfBGPNeighbors": { + "type_name": "VrfBGPNeighbors", + "description": "VrfBGPNeighbors struct for VrfBGPNeighbors", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "PeerAs": { + "name": "PeerAs", + "description": "The ASN of the peer that advertised the prefix.", + "json_tag": "peer_as" + }, + "PeerIp": { + "name": "PeerIp", + "description": "", + "json_tag": "peer_ip" + }, + "State": { + "name": "State", + "description": "The current status of the connection to the BGP peer. State is either up or down.", + "json_tag": "state" + } + } + }, + "VrfBGPNeighborsList": { + "type_name": "VrfBGPNeighborsList", + "description": "VrfBGPNeighborsList struct for VrfBGPNeighborsList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpNeighbors": { + "name": "BgpNeighbors", + "description": "", + "json_tag": "bgp_neighbors" + } + } + }, + "VrfCreateInput": { + "type_name": "VrfCreateInput", + "description": "VrfCreateInput struct for VrfCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpDynamicNeighborsBfdEnabled": { + "name": "BgpDynamicNeighborsBfdEnabled", + "description": "Toggle BFD on dynamic bgp neighbors sessions", + "json_tag": "bgp_dynamic_neighbors_bfd_enabled" + }, + "BgpDynamicNeighborsEnabled": { + "name": "BgpDynamicNeighborsEnabled", + "description": "Toggle to enable the dynamic bgp neighbors feature on the VRF", + "json_tag": "bgp_dynamic_neighbors_enabled" + }, + "BgpDynamicNeighborsExportRouteMap": { + "name": "BgpDynamicNeighborsExportRouteMap", + "description": "Toggle to export the VRF route-map to the dynamic bgp neighbors", + "json_tag": "bgp_dynamic_neighbors_export_route_map" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "IpRanges": { + "name": "IpRanges", + "description": "A list of CIDR network addresses. Like [\\\"10.0.0.0/16\\\", \\\"2001:d78::/59\\\"]. IPv4 blocks must be between /8 and /29 in size. IPv6 blocks must be between /59 and /64. A VRF\\\\'s IP ranges must be defined in order to create VRF IP Reservations, which can then be used for Metal Gateways or Virtual Circuits.", + "json_tag": "ip_ranges" + }, + "LocalAsn": { + "name": "LocalAsn", + "description": "", + "json_tag": "local_asn" + }, + "Metro": { + "name": "Metro", + "description": "The UUID (or metro code) for the Metro in which to create this VRF.", + "json_tag": "metro" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "VrfFabricVcCreateInput": { + "type_name": "VrfFabricVcCreateInput", + "description": "VrfFabricVcCreateInput struct for VrfFabricVcCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ContactEmail": { + "name": "ContactEmail", + "description": "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.", + "json_tag": "contact_email" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "FacilityId": { + "name": "FacilityId", + "description": "", + "json_tag": "facility_id" + }, + "Metro": { + "name": "Metro", + "description": "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.", + "json_tag": "metro" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Redundancy": { + "name": "Redundancy", + "description": "Either 'primary' or 'redundant'.", + "json_tag": "redundancy" + }, + "ServiceTokenType": { + "name": "ServiceTokenType", + "description": "", + "json_tag": "service_token_type" + }, + "Speed": { + "name": "Speed", + "description": "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.", + "json_tag": "speed" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Vrfs": { + "name": "Vrfs", + "description": "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_tag": "vrfs" + } + } + }, + "VrfIpReservation": { + "type_name": "VrfIpReservation", + "description": "VrfIpReservation struct for VrfIpReservation", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "", + "json_tag": "address" + }, + "AddressFamily": { + "name": "AddressFamily", + "description": "", + "json_tag": "address_family" + }, + "Bill": { + "name": "Bill", + "description": "", + "json_tag": "bill" + }, + "Cidr": { + "name": "Cidr", + "description": "", + "json_tag": "cidr" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "", + "json_tag": "created_by" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "Gateway": { + "name": "Gateway", + "description": "", + "json_tag": "gateway" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Manageable": { + "name": "Manageable", + "description": "", + "json_tag": "manageable" + }, + "Management": { + "name": "Management", + "description": "", + "json_tag": "management" + }, + "MetalGateway": { + "name": "MetalGateway", + "description": "", + "json_tag": "metal_gateway" + }, + "Metro": { + "name": "Metro", + "description": "", + "json_tag": "metro" + }, + "Netmask": { + "name": "Netmask", + "description": "", + "json_tag": "netmask" + }, + "Network": { + "name": "Network", + "description": "", + "json_tag": "network" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "ProjectLite": { + "name": "ProjectLite", + "description": "", + "json_tag": "project_lite" + }, + "Public": { + "name": "Public", + "description": "", + "json_tag": "public" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Vrf": { + "name": "Vrf", + "description": "", + "json_tag": "vrf" + } + } + }, + "VrfIpReservationCreateInput": { + "type_name": "VrfIpReservationCreateInput", + "description": "VrfIpReservationCreateInput struct for VrfIpReservationCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cidr": { + "name": "Cidr", + "description": "The size of the VRF IP Reservation's subnet. The following subnet sizes are supported: - IPv4: between 22 - 29 inclusive - IPv6: exactly 64", + "json_tag": "cidr" + }, + "Customdata": { + "name": "Customdata", + "description": "", + "json_tag": "customdata" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "Network": { + "name": "Network", + "description": "The starting address for this VRF IP Reservation's subnet. Both IPv4 and IPv6 are supported.", + "json_tag": "network" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "Must be set to 'vrf'", + "json_tag": "type" + }, + "VrfId": { + "name": "VrfId", + "description": "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'.", + "json_tag": "vrf_id" + } + } + }, + "VrfIpReservationList": { + "type_name": "VrfIpReservationList", + "description": "VrfIpReservationList struct for VrfIpReservationList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "IpAddresses": { + "name": "IpAddresses", + "description": "", + "json_tag": "ip_addresses" + } + } + }, + "VrfLearnedRoutes": { + "type_name": "VrfLearnedRoutes", + "description": "VrfLearnedRoutes struct for VrfLearnedRoutes", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "OriginAs": { + "name": "OriginAs", + "description": "The ASN of the peer that advertised the prefix.", + "json_tag": "origin_as" + }, + "Prefix": { + "name": "Prefix", + "description": "", + "json_tag": "prefix" + } + } + }, + "VrfLearnedRoutesList": { + "type_name": "VrfLearnedRoutesList", + "description": "VrfLearnedRoutesList struct for VrfLearnedRoutesList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "LearnedRoutes": { + "name": "LearnedRoutes", + "description": "", + "json_tag": "learned_routes" + } + } + }, + "VrfList": { + "type_name": "VrfList", + "description": "VrfList struct for VrfList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + }, + "Vrfs": { + "name": "Vrfs", + "description": "", + "json_tag": "vrfs" + } + } + }, + "VrfMetalGateway": { + "type_name": "VrfMetalGateway", + "description": "VrfMetalGateway struct for VrfMetalGateway", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "CreatedBy": { + "name": "CreatedBy", + "description": "", + "json_tag": "created_by" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "IpReservation": { + "name": "IpReservation", + "description": "", + "json_tag": "ip_reservation" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "State": { + "name": "State", + "description": "", + "json_tag": "state" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "VirtualNetwork": { + "name": "VirtualNetwork", + "description": "", + "json_tag": "virtual_network" + }, + "Vrf": { + "name": "Vrf", + "description": "", + "json_tag": "vrf" + } + } + }, + "VrfMetalGatewayCreateInput": { + "type_name": "VrfMetalGatewayCreateInput", + "description": "VrfMetalGatewayCreateInput struct for VrfMetalGatewayCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "IpReservationId": { + "name": "IpReservationId", + "description": "The UUID an a VRF IP Reservation that belongs to the same project as the one in which the Metal Gateway is to be created. Additionally, the VRF IP Reservation and the Virtual Network must reside in the same Metro.", + "json_tag": "ip_reservation_id" + }, + "VirtualNetworkId": { + "name": "VirtualNetworkId", + "description": "The UUID of a Metro Virtual Network that belongs to the same project as the one in which the Metal Gateway is to be created. Additionally, the Virtual Network and the VRF IP Reservation must reside in the same metro. In the case of the IP reservation being an IPv6 based VRF IP Reservation, the Virtual Network must not already have an associated IPv6 based VRF IP Reservation. There can be exactly one IPv6 based VRF IP Reservation associated to a Virtual Network.", + "json_tag": "virtual_network_id" + } + } + }, + "VrfRoute": { + "type_name": "VrfRoute", + "description": "VrfRoute struct for VrfRoute", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Id": { + "name": "Id", + "description": "The unique identifier for the newly-created resource", + "json_tag": "id" + }, + "MetalGateway": { + "name": "MetalGateway", + "description": "", + "json_tag": "metal_gateway" + }, + "NextHop": { + "name": "NextHop", + "description": "The next-hop IPv4 address for the route", + "json_tag": "next_hop" + }, + "Prefix": { + "name": "Prefix", + "description": "The IPv4 prefix for the route, in CIDR-style notation", + "json_tag": "prefix" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "VirtualNetwork": { + "name": "VirtualNetwork", + "description": "", + "json_tag": "virtual_network" + }, + "Vrf": { + "name": "Vrf", + "description": "", + "json_tag": "vrf" + } + } + }, + "VrfRouteCreateInput": { + "type_name": "VrfRouteCreateInput", + "description": "VrfRouteCreateInput struct for VrfRouteCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "NextHop": { + "name": "NextHop", + "description": "The IPv4 address within the VRF of the host that will handle this route", + "json_tag": "next_hop" + }, + "Prefix": { + "name": "Prefix", + "description": "The IPv4 prefix for the route, in CIDR-style notation. For a static default route, this will always be \\\"0.0.0.0/0\\\"", + "json_tag": "prefix" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "VrfRouteList": { + "type_name": "VrfRouteList", + "description": "VrfRouteList struct for VrfRouteList", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Meta": { + "name": "Meta", + "description": "", + "json_tag": "meta" + }, + "Routes": { + "name": "Routes", + "description": "", + "json_tag": "routes" + } + } + }, + "VrfRouteUpdateInput": { + "type_name": "VrfRouteUpdateInput", + "description": "VrfRouteUpdateInput struct for VrfRouteUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "NextHop": { + "name": "NextHop", + "description": "The IPv4 address within the VRF of the host that will handle this route", + "json_tag": "next_hop" + }, + "Prefix": { + "name": "Prefix", + "description": "The IPv4 prefix for the route, in CIDR-style notation. For a static default route, this will always be \\\"0.0.0.0/0\\\"", + "json_tag": "prefix" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "VrfUpdateInput": { + "type_name": "VrfUpdateInput", + "description": "VrfUpdateInput struct for VrfUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "BgpDynamicNeighborsBfdEnabled": { + "name": "BgpDynamicNeighborsBfdEnabled", + "description": "Toggle BFD on dynamic bgp neighbors sessions", + "json_tag": "bgp_dynamic_neighbors_bfd_enabled" + }, + "BgpDynamicNeighborsEnabled": { + "name": "BgpDynamicNeighborsEnabled", + "description": "Toggle to enable the dynamic bgp neighbors feature on the VRF", + "json_tag": "bgp_dynamic_neighbors_enabled" + }, + "BgpDynamicNeighborsExportRouteMap": { + "name": "BgpDynamicNeighborsExportRouteMap", + "description": "Toggle to export the VRF route-map to the dynamic bgp neighbors", + "json_tag": "bgp_dynamic_neighbors_export_route_map" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "IpRanges": { + "name": "IpRanges", + "description": "A list of CIDR network addresses. Like [\\\"10.0.0.0/16\\\", \\\"2001:d78::/59\\\"]. IPv4 blocks must be between /8 and /29 in size. IPv6 blocks must be between /59 and /64. A VRF\\\\'s IP ranges must be defined in order to create VRF IP Reservations, which can then be used for Metal Gateways or Virtual Circuits. Adding a new CIDR address to the list will result in the creation of a new IP Range for this VRF. Removal of an existing CIDR address from the list will result in the deletion of an existing IP Range for this VRF. Deleting an IP Range will result in the deletion of any VRF IP Reservations contained within the IP Range, as well as the VRF IP Reservation\\\\'s associated Metal Gateways or Virtual Circuits. If you do not wish to add or remove IP Ranges, either include the full existing list of IP Ranges in the update request, or do not specify the `ip_ranges` field in the update request. Specifying a value of `[]` will remove all existing IP Ranges from the VRF.", + "json_tag": "ip_ranges" + }, + "LocalAsn": { + "name": "LocalAsn", + "description": "The new `local_asn` value for the VRF. This field cannot be updated when there are active Interconnection Virtual Circuits associated to the VRF, or if any of the VLANs of the VRF's metal gateway has been assigned on an instance.", + "json_tag": "local_asn" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "VrfVirtualCircuit": { + "type_name": "VrfVirtualCircuit", + "description": "VrfVirtualCircuit struct for VrfVirtualCircuit", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "", + "json_tag": "created_at" + }, + "CustomerIp": { + "name": "CustomerIp", + "description": "An IPv4 address from the subnet that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Metal IP. By default, the last usable IP address in the subnet will be used.", + "json_tag": "customer_ip" + }, + "CustomerIpv6": { + "name": "CustomerIpv6", + "description": "An IPv6 address from the subnet IPv6 that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet IPv6 as the Metal IPv6. By default, the last usable IP address in the subnet IPv6 will be used.", + "json_tag": "customer_ipv6" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Id": { + "name": "Id", + "description": "", + "json_tag": "id" + }, + "Md5": { + "name": "Md5", + "description": "The MD5 password for the BGP peering in plaintext (not a checksum).", + "json_tag": "md5" + }, + "MetalIp": { + "name": "MetalIp", + "description": "An IPv4 address from the subnet that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Customer IP. By default, the first usable IP address in the subnet will be used.", + "json_tag": "metal_ip" + }, + "MetalIpv6": { + "name": "MetalIpv6", + "description": "An IPv6 address from the subnet IPv6 that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IPv6 address in the subnet IPv6 as the Customer IP. By default, the first usable IPv6 address in the subnet IPv6 will be used.", + "json_tag": "metal_ipv6" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "NniVlan": { + "name": "NniVlan", + "description": "", + "json_tag": "nni_vlan" + }, + "PeerAsn": { + "name": "PeerAsn", + "description": "The peer ASN that will be used with the VRF on the Virtual Circuit.", + "json_tag": "peer_asn" + }, + "Port": { + "name": "Port", + "description": "", + "json_tag": "port" + }, + "Project": { + "name": "Project", + "description": "", + "json_tag": "project" + }, + "Speed": { + "name": "Speed", + "description": "integer representing bps speed", + "json_tag": "speed" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "Subnet": { + "name": "Subnet", + "description": "The /30 or /31 IPv4 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IP and Customer IP must be IPs from this subnet. For /30 subnets, the network and broadcast IPs cannot be used as the Metal or Customer IP.", + "json_tag": "subnet" + }, + "SubnetIpv6": { + "name": "SubnetIpv6", + "description": "The /126 or /127 IPv6 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IPv6 and Customer IPv6 must be IPs from this subnet. For /126 subnets, the network and broadcast IPs cannot be used as the Metal IPv6 or Customer IPv6. The subnet specified must be contained within an already-defined IP Range for the VRF.", + "json_tag": "subnet_ipv6" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "UpdatedAt": { + "name": "UpdatedAt", + "description": "", + "json_tag": "updated_at" + }, + "Vrf": { + "name": "Vrf", + "description": "", + "json_tag": "vrf" + } + } + }, + "VrfVirtualCircuitCreateInput": { + "type_name": "VrfVirtualCircuitCreateInput", + "description": "VrfVirtualCircuitCreateInput struct for VrfVirtualCircuitCreateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerIp": { + "name": "CustomerIp", + "description": "An IPv4 address from the subnet that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Metal IP. By default, the last usable IP address in the subnet will be used.", + "json_tag": "customer_ip" + }, + "CustomerIpv6": { + "name": "CustomerIpv6", + "description": "An IPv6 address from the subnet IPv6 that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet IPv6 as the Metal IPv6. By default, the last usable IP address in the subnet IPv6 will be used.", + "json_tag": "customer_ipv6" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Md5": { + "name": "Md5", + "description": "The plaintext BGP peering password shared by 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", + "json_tag": "md5" + }, + "MetalIp": { + "name": "MetalIp", + "description": "An IPv4 address from the subnet that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Customer IP. By default, the first usable IP address in the subnet will be used.", + "json_tag": "metal_ip" + }, + "MetalIpv6": { + "name": "MetalIpv6", + "description": "An IPv6 address from the subnet IPv6 that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IPv6 address in the subnet IPv6 as the Customer IP. By default, the first usable IPv6 address in the subnet IPv6 will be used.", + "json_tag": "metal_ipv6" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "NniVlan": { + "name": "NniVlan", + "description": "", + "json_tag": "nni_vlan" + }, + "PeerAsn": { + "name": "PeerAsn", + "description": "The peer ASN that will be used with the VRF on the Virtual Circuit.", + "json_tag": "peer_asn" + }, + "ProjectId": { + "name": "ProjectId", + "description": "", + "json_tag": "project_id" + }, + "Speed": { + "name": "Speed", + "description": "speed can be passed as integer number representing bps speed or string (e.g. '52m' or '100g' or '4 gbps')", + "json_tag": "speed" + }, + "Subnet": { + "name": "Subnet", + "description": "The /30 or /31 IPv4 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IP and Customer IP must be IPs from this subnet. For /30 subnets, the network and broadcast IPs cannot be used as the Metal or Customer IP. The subnet specified must be contained within an already-defined IP Range for the VRF.", + "json_tag": "subnet" + }, + "SubnetIpv6": { + "name": "SubnetIpv6", + "description": "The /126 or /127 IPv6 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IPv6 and Customer IPv6 must be IPs from this subnet. For /126 subnets, the network and broadcast IPs cannot be used as the Metal IPv6 or Customer IPv6. The subnet specified must be contained within an already-defined IP Range for the VRF.", + "json_tag": "subnet_ipv6" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + }, + "Vrf": { + "name": "Vrf", + "description": "The UUID of the VRF that will be associated with the Virtual Circuit.", + "json_tag": "vrf" + } + } + }, + "VrfVirtualCircuitUpdateInput": { + "type_name": "VrfVirtualCircuitUpdateInput", + "description": "VrfVirtualCircuitUpdateInput struct for VrfVirtualCircuitUpdateInput", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CustomerIp": { + "name": "CustomerIp", + "description": "An IPv4 address from the subnet that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Metal IP. By default, the last usable IP address in the subnet will be used.", + "json_tag": "customer_ip" + }, + "CustomerIpv6": { + "name": "CustomerIpv6", + "description": "An IPv6 address from the subnet IPv6 that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet IPv6 as the Metal IPv6. By default, the last usable IP address in the subnet IPv6 will be used.", + "json_tag": "customer_ipv6" + }, + "Description": { + "name": "Description", + "description": "", + "json_tag": "description" + }, + "Md5": { + "name": "Md5", + "description": "The plaintext BGP peering password shared by 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", + "json_tag": "md5" + }, + "MetalIp": { + "name": "MetalIp", + "description": "An IPv4 address from the subnet that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Customer IP. By default, the first usable IP address in the subnet will be used.", + "json_tag": "metal_ip" + }, + "MetalIpv6": { + "name": "MetalIpv6", + "description": "An IPv6 address from the subnet IPv6 that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IPv6 address in the subnet IPv6 as the Customer IP. By default, the first usable IPv6 address in the subnet IPv6 will be used.", + "json_tag": "metal_ipv6" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + }, + "PeerAsn": { + "name": "PeerAsn", + "description": "The peer ASN that will be used with the VRF on the Virtual Circuit.", + "json_tag": "peer_asn" + }, + "Speed": { + "name": "Speed", + "description": "Speed can be changed only if it is an interconnection on a Dedicated Port", + "json_tag": "speed" + }, + "Subnet": { + "name": "Subnet", + "description": "The /30 or /31 IPv4 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IP and Customer IP must be IPs from this subnet. For /30 subnets, the network and broadcast IPs cannot be used as the Metal or Customer IP.", + "json_tag": "subnet" + }, + "SubnetIpv6": { + "name": "SubnetIpv6", + "description": "The /126 or /127 IPv6 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IPv6 and Customer IPv6 must be IPs from this subnet. For /126 subnets, the network and broadcast IPs cannot be used as the Metal IPv6 or Customer IPv6. The subnet specified must be contained within an already-defined IP Range for the VRF.", + "json_tag": "subnet_ipv6" + }, + "Tags": { + "name": "Tags", + "description": "", + "json_tag": "tags" + } + } + }, + "formFile": { + "type_name": "formFile", + "fields": { + "fileBytes": { + "name": "fileBytes", + "description": "" + }, + "fileName": { + "name": "fileName", + "description": "" + }, + "formFileName": { + "name": "formFileName", + "description": "" + } + } + }, + "service": { + "type_name": "service", + "fields": { + "client": { + "name": "client", + "description": "" + } + } + } + } +} \ No newline at end of file diff --git a/cmd/descriptions/orderhistoryv1.json b/cmd/descriptions/orderhistoryv1.json new file mode 100644 index 0000000..13ea172 --- /dev/null +++ b/cmd/descriptions/orderhistoryv1.json @@ -0,0 +1,1120 @@ +{ + "services": { + "retrieve-orders": { + "service_name": "retrieve-orders", + "service_description": "", + "methods": { + "GETRetrieveOrdersLocations": { + "short_description": "Retrieve order permissible IBX locations", + "long_description": "The API returns locations (IBXs and Cages) where the user's organization has a presence. The user may be able to view orders related to these locations, depending on their permissions.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GETRetrieveOrdersLocationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "POSTOrdersHistory": { + "short_description": "Search Orders History", + "long_description": "Based on filtering criteria, this method returns a list of orders from the last 12 months for IBX locations where the user has permissions.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "POSTOrdersHistoryExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGETRetrieveOrdersLocationsRequest": { + "type_name": "ApiGETRetrieveOrdersLocationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiPOSTOrdersHistoryRequest": { + "type_name": "ApiPOSTOrdersHistoryRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + } + } + } + }, + "types": { + "APIClient": { + "type_name": "APIClient", + "description": "APIClient manages communication with the Retrieve Orders API API v1.0.0\nIn most cases there should be only one, shared, APIClient.", + "fields": { + "RetrieveOrdersApi": { + "name": "RetrieveOrdersApi", + "description": "" + }, + "cfg": { + "name": "cfg", + "description": "" + }, + "common": { + "name": "common", + "description": "Reuse a single struct instead of allocating one for each service on the heap." + } + } + }, + "APIKey": { + "type_name": "APIKey", + "description": "APIKey provides API key based authentication to a request passed via context using ContextAPIKey", + "fields": { + "Key": { + "name": "Key", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "" + } + } + }, + "APIResponse": { + "type_name": "APIResponse", + "description": "APIResponse stores the API response returned by the server.", + "fields": { + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "Method": { + "name": "Method", + "description": "Method is the HTTP method used for the request. This value is always\navailable, even if the embedded *http.Response is nil.", + "json_tag": "method" + }, + "Operation": { + "name": "Operation", + "description": "Operation is the name of the OpenAPI operation.", + "json_tag": "operation" + }, + "Payload": { + "name": "Payload", + "description": "Payload holds the contents of the response body (which may be nil or empty).\nThis is provided here as the raw response.Body() reader will have already\nbeen drained.", + "json_tag": "-" + }, + "RequestURL": { + "name": "RequestURL", + "description": "RequestURL is the request URL. This value is always available, even if the\nembedded *http.Response is nil.", + "json_tag": "url" + } + } + }, + "Account": { + "type_name": "Account", + "description": "Account struct for Account", + "fields": { + "AccountName": { + "name": "AccountName", + "description": "Name of Account", + "json_tag": "accountName" + }, + "AccountNumber": { + "name": "AccountNumber", + "description": "Account Number", + "json_tag": "accountNumber" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + } + } + }, + "ApiGETRetrieveOrdersLocationsRequest": { + "type_name": "ApiGETRetrieveOrdersLocationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiPOSTOrdersHistoryRequest": { + "type_name": "ApiPOSTOrdersHistoryRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "BasicAuth": { + "type_name": "BasicAuth", + "description": "BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth", + "fields": { + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "UserName": { + "name": "UserName", + "description": "", + "json_tag": "userName" + } + } + }, + "Configuration": { + "type_name": "Configuration", + "description": "Configuration stores the configuration of the API client", + "fields": { + "Debug": { + "name": "Debug", + "description": "", + "json_tag": "debug" + }, + "DefaultHeader": { + "name": "DefaultHeader", + "description": "", + "json_tag": "defaultHeader" + }, + "HTTPClient": { + "name": "HTTPClient", + "description": "" + }, + "Host": { + "name": "Host", + "description": "", + "json_tag": "host" + }, + "OperationServers": { + "name": "OperationServers", + "description": "" + }, + "Scheme": { + "name": "Scheme", + "description": "", + "json_tag": "scheme" + }, + "Servers": { + "name": "Servers", + "description": "" + }, + "UserAgent": { + "name": "UserAgent", + "description": "", + "json_tag": "userAgent" + } + } + }, + "Filters": { + "type_name": "Filters", + "description": "Filters struct for Filters", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DateRange": { + "name": "DateRange", + "description": "", + "json_tag": "dateRange" + }, + "FromDate": { + "name": "FromDate", + "description": "Date Format Should be mm/dd/yyyy.\u003cbr/\u003e Not applicable when dateRange is provided.", + "json_tag": "fromDate" + }, + "Ibxs": { + "name": "Ibxs", + "description": "ibxs filter", + "json_tag": "ibxs" + }, + "OrderStatus": { + "name": "OrderStatus", + "description": "order status filter", + "json_tag": "orderStatus" + }, + "ProductTypes": { + "name": "ProductTypes", + "description": "Product(order type) filter", + "json_tag": "productTypes" + }, + "ToDate": { + "name": "ToDate", + "description": "Date Format Should be mm/dd/yyyy.\u003cbr/\u003e Not applicable when dateRange is provided", + "json_tag": "toDate" + } + } + }, + "GenericError": { + "type_name": "GenericError", + "description": "GenericError struct for GenericError", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Errors": { + "name": "Errors", + "description": "", + "json_tag": "errors" + }, + "TicketId": { + "name": "TicketId", + "description": "", + "json_tag": "ticketId" + } + } + }, + "GenericOpenAPIError": { + "type_name": "GenericOpenAPIError", + "description": "GenericOpenAPIError Provides access to the body, error and model on returned errors.", + "fields": { + "body": { + "name": "body", + "description": "" + }, + "error": { + "name": "error", + "description": "" + }, + "model": { + "name": "model", + "description": "" + } + } + }, + "IbxDetailForLocationsEndpoint": { + "type_name": "IbxDetailForLocationsEndpoint", + "description": "IbxDetailForLocationsEndpoint struct for IbxDetailForLocationsEndpoint", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Address": { + "name": "Address", + "description": "Address of the ibx", + "json_tag": "address" + }, + "City": { + "name": "City", + "description": "City where ibx is located", + "json_tag": "city" + }, + "Code": { + "name": "Code", + "description": "Ibx Code", + "json_tag": "code" + }, + "Country": { + "name": "Country", + "description": "Country where ibx is located", + "json_tag": "country" + }, + "Metro": { + "name": "Metro", + "description": "Metro code where ibx is located", + "json_tag": "metro" + }, + "PostalCode": { + "name": "PostalCode", + "description": "Postal code of ibx location", + "json_tag": "postalCode" + }, + "Region": { + "name": "Region", + "description": "Region where ibx is located", + "json_tag": "region" + }, + "State": { + "name": "State", + "description": "State where ibx is located", + "json_tag": "state" + } + } + }, + "Link": { + "type_name": "Link", + "description": "Link struct for Link", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Href": { + "name": "Href", + "description": "", + "json_tag": "href" + }, + "Rel": { + "name": "Rel", + "description": "", + "json_tag": "rel" + } + } + }, + "NotificationContact": { + "type_name": "NotificationContact", + "description": "NotificationContact struct for NotificationContact", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Email": { + "name": "Email", + "description": "Notification Contact email", + "json_tag": "email" + }, + "Name": { + "name": "Name", + "description": "Notification Contact name", + "json_tag": "name" + }, + "Phone": { + "name": "Phone", + "description": "Notification Contact phone", + "json_tag": "phone" + } + } + }, + "NullableAccount": { + "type_name": "NullableAccount", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBool": { + "type_name": "NullableBool", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFilters": { + "type_name": "NullableFilters", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFiltersDateRange": { + "type_name": "NullableFiltersDateRange", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat32": { + "type_name": "NullableFloat32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat64": { + "type_name": "NullableFloat64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGenericError": { + "type_name": "NullableGenericError", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIbxDetailForLocationsEndpoint": { + "type_name": "NullableIbxDetailForLocationsEndpoint", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt": { + "type_name": "NullableInt", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt32": { + "type_name": "NullableInt32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt64": { + "type_name": "NullableInt64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLink": { + "type_name": "NullableLink", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLinkRel": { + "type_name": "NullableLinkRel", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNotificationContact": { + "type_name": "NullableNotificationContact", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderHeader": { + "type_name": "NullableOrderHeader", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderHeaderStatusEnum": { + "type_name": "NullableOrderHeaderStatusEnum", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderHistoryResponse": { + "type_name": "NullableOrderHistoryResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderSourceEnum": { + "type_name": "NullableOrderSourceEnum", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderhistoryapirequest": { + "type_name": "NullableOrderhistoryapirequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderhistoryapirequestSourceInner": { + "type_name": "NullableOrderhistoryapirequestSourceInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderingContact": { + "type_name": "NullableOrderingContact", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePageDetailsForResponse": { + "type_name": "NullablePageDetailsForResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePageRequestModel": { + "type_name": "NullablePageRequestModel", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePermissibleLocation": { + "type_name": "NullablePermissibleLocation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProductTypesEnum": { + "type_name": "NullableProductTypesEnum", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSort": { + "type_name": "NullableSort", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSortDirection": { + "type_name": "NullableSortDirection", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSortName": { + "type_name": "NullableSortName", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableString": { + "type_name": "NullableString", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTime": { + "type_name": "NullableTime", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "OrderHeader": { + "type_name": "OrderHeader", + "description": "OrderHeader struct for OrderHeader", + "fields": { + "Account": { + "name": "Account", + "description": "", + "json_tag": "account" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedAt": { + "name": "CreatedAt", + "description": "Order Created DateTime in ISO Date Format", + "json_tag": "createdAt" + }, + "CustomerReferenceNumbers": { + "name": "CustomerReferenceNumbers", + "description": "List of customer reference numbers for the order lines.", + "json_tag": "customerReferenceNumbers" + }, + "Ibx": { + "name": "Ibx", + "description": "List of ibxs for the order lines.", + "json_tag": "ibx" + }, + "Links": { + "name": "Links", + "description": "", + "json_tag": "links" + }, + "NotificationContact": { + "name": "NotificationContact", + "description": "", + "json_tag": "notificationContact" + }, + "OrderNumber": { + "name": "OrderNumber", + "description": "Order number", + "json_tag": "orderNumber" + }, + "OrderStatus": { + "name": "OrderStatus", + "description": "", + "json_tag": "orderStatus" + }, + "OrderingContact": { + "name": "OrderingContact", + "description": "", + "json_tag": "orderingContact" + }, + "Type": { + "name": "Type", + "description": "List Of Proudcts Ordered in the Order.", + "json_tag": "type" + } + } + }, + "OrderHistoryResponse": { + "type_name": "OrderHistoryResponse", + "description": "OrderHistoryResponse struct for OrderHistoryResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Content": { + "name": "Content", + "description": "", + "json_tag": "content" + }, + "Links": { + "name": "Links", + "description": "", + "json_tag": "links" + }, + "Page": { + "name": "Page", + "description": "", + "json_tag": "page" + } + } + }, + "Orderhistoryapirequest": { + "type_name": "Orderhistoryapirequest", + "description": "Orderhistoryapirequest struct for Orderhistoryapirequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Filters": { + "name": "Filters", + "description": "", + "json_tag": "filters" + }, + "Page": { + "name": "Page", + "description": "", + "json_tag": "page" + }, + "Q": { + "name": "Q", + "description": "Query value to be queried against source values(Or operation against all sources).\u003cbr/\u003eSupports partial text search", + "json_tag": "q" + }, + "Sorts": { + "name": "Sorts", + "description": "", + "json_tag": "sorts" + }, + "Source": { + "name": "Source", + "description": "\u003cb\u003eORDER_NUMBER:\u003c/b\u003e Search by order number(1-123456789).\u003cbr\u003e\u003cb\u003eCUSTOMER_REFERENCE_NUMBER:\u003c/b\u003e Search by customer reference number which was entered as part place order.\u003cbr\u003e\u003cb\u003eTROUBLE_TICKET_NUMBER:\u003c/b\u003e Search by trouble ticket numnber(5-123456).\u003cbr\u003e\u003cb\u003eWORK_ACTIVITY_NUMBER:\u003c/b\u003e Search by work order activity number(3-123456).", + "json_tag": "source" + } + } + }, + "OrderingContact": { + "type_name": "OrderingContact", + "description": "OrderingContact struct for OrderingContact", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Email": { + "name": "Email", + "description": "Ordering Contact email", + "json_tag": "email" + }, + "Name": { + "name": "Name", + "description": "Ordering Contact name", + "json_tag": "name" + }, + "Phone": { + "name": "Phone", + "description": "Ordering Contact phone", + "json_tag": "phone" + } + } + }, + "PageDetailsForResponse": { + "type_name": "PageDetailsForResponse", + "description": "PageDetailsForResponse struct for PageDetailsForResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Number": { + "name": "Number", + "description": "Current page number", + "json_tag": "number" + }, + "Size": { + "name": "Size", + "description": "Page Size", + "json_tag": "size" + }, + "TotalElements": { + "name": "TotalElements", + "description": "Total number of records", + "json_tag": "totalElements" + }, + "TotalPages": { + "name": "TotalPages", + "description": "Total number of pages", + "json_tag": "totalPages" + } + } + }, + "PageRequestModel": { + "type_name": "PageRequestModel", + "description": "PageRequestModel struct for PageRequestModel", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Number": { + "name": "Number", + "description": "Page number indexed from 0.", + "json_tag": "number" + }, + "Size": { + "name": "Size", + "description": "Page Size.", + "json_tag": "size" + } + } + }, + "PermissibleLocation": { + "type_name": "PermissibleLocation", + "description": "PermissibleLocation struct for PermissibleLocation", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cages": { + "name": "Cages", + "description": "", + "json_tag": "cages" + }, + "Ibx": { + "name": "Ibx", + "description": "", + "json_tag": "ibx" + } + } + }, + "ServerConfiguration": { + "type_name": "ServerConfiguration", + "description": "ServerConfiguration stores the information about a server", + "fields": { + "Description": { + "name": "Description", + "description": "" + }, + "URL": { + "name": "URL", + "description": "" + }, + "Variables": { + "name": "Variables", + "description": "" + } + } + }, + "ServerVariable": { + "type_name": "ServerVariable", + "description": "ServerVariable stores the information about a server variable", + "fields": { + "DefaultValue": { + "name": "DefaultValue", + "description": "" + }, + "Description": { + "name": "Description", + "description": "" + }, + "EnumValues": { + "name": "EnumValues", + "description": "" + } + } + }, + "Sort": { + "type_name": "Sort", + "description": "Sort struct for Sort", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Direction": { + "name": "Direction", + "description": "", + "json_tag": "direction" + }, + "Name": { + "name": "Name", + "description": "", + "json_tag": "name" + } + } + }, + "formFile": { + "type_name": "formFile", + "fields": { + "fileBytes": { + "name": "fileBytes", + "description": "" + }, + "fileName": { + "name": "fileName", + "description": "" + }, + "formFileName": { + "name": "formFileName", + "description": "" + } + } + }, + "service": { + "type_name": "service", + "fields": { + "client": { + "name": "client", + "description": "" + } + } + } + } +} \ No newline at end of file diff --git a/cmd/descriptions/ordersv2.json b/cmd/descriptions/ordersv2.json new file mode 100644 index 0000000..cfbe63f --- /dev/null +++ b/cmd/descriptions/ordersv2.json @@ -0,0 +1,1697 @@ +{ + "services": { + "orders": { + "service_name": "orders", + "service_description": "", + "methods": { + "AddNotesToAnOrder": { + "short_description": "Add notes to an order", + "long_description": "This method adds notes to an order by its ID for a user with permission to view this request.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "orderId", + "description": "Identifier of the order" + } + ] + }, + "AddNotesToAnOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "CancelAnOrder": { + "short_description": "Cancel an order", + "long_description": "This method cancels an order by its ID for a user with permission to view this request.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "orderId", + "description": "Identifier of the order" + } + ] + }, + "CancelAnOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "GETOrderDetails": { + "short_description": "Retrieve an order", + "long_description": "This method retrieves an order by its ID for a user with permission to view this request.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "orderId", + "description": "Identifier of the Order" + } + ] + }, + "GETOrderDetailsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "ReplyToAnOrderNegotiation": { + "short_description": "Reply to an order negotiation", + "long_description": "This method approves or rejects an order negotiation for a user with permission to view this request.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "orderId", + "description": "Identifier of the order" + } + ] + }, + "ReplyToAnOrderNegotiationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "RetrieveOrderNegotiations": { + "short_description": "Retrieve order negotiations", + "long_description": "This method retrieves order negotiations by its ID for a user with permission to view this request.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "orderId", + "description": "Identifier of the order" + } + ] + }, + "RetrieveOrderNegotiationsExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiAddNotesToAnOrderRequest": { + "type_name": "ApiAddNotesToAnOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "noteRequest": { + "name": "noteRequest", + "description": "" + }, + "orderId": { + "name": "orderId", + "description": "" + } + } + }, + "ApiCancelAnOrderRequest": { + "type_name": "ApiCancelAnOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cancelRequest": { + "name": "cancelRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "orderId": { + "name": "orderId", + "description": "" + } + } + }, + "ApiGETOrderDetailsRequest": { + "type_name": "ApiGETOrderDetailsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "ibxs": { + "name": "ibxs", + "description": "" + }, + "orderId": { + "name": "orderId", + "description": "" + } + } + }, + "ApiReplyToAnOrderNegotiationRequest": { + "type_name": "ApiReplyToAnOrderNegotiationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "negotiationsRequest": { + "name": "negotiationsRequest", + "description": "" + }, + "orderId": { + "name": "orderId", + "description": "" + } + } + }, + "ApiRetrieveOrderNegotiationsRequest": { + "type_name": "ApiRetrieveOrderNegotiationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "orderId": { + "name": "orderId", + "description": "" + } + } + } + } + } + }, + "types": { + "APIClient": { + "type_name": "APIClient", + "description": "APIClient manages communication with the Orders API v2.0-beta\nIn most cases there should be only one, shared, APIClient.", + "fields": { + "OrdersApi": { + "name": "OrdersApi", + "description": "" + }, + "cfg": { + "name": "cfg", + "description": "" + }, + "common": { + "name": "common", + "description": "Reuse a single struct instead of allocating one for each service on the heap." + } + } + }, + "APIKey": { + "type_name": "APIKey", + "description": "APIKey provides API key based authentication to a request passed via context using ContextAPIKey", + "fields": { + "Key": { + "name": "Key", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "" + } + } + }, + "APIResponse": { + "type_name": "APIResponse", + "description": "APIResponse stores the API response returned by the server.", + "fields": { + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "Method": { + "name": "Method", + "description": "Method is the HTTP method used for the request. This value is always\navailable, even if the embedded *http.Response is nil.", + "json_tag": "method" + }, + "Operation": { + "name": "Operation", + "description": "Operation is the name of the OpenAPI operation.", + "json_tag": "operation" + }, + "Payload": { + "name": "Payload", + "description": "Payload holds the contents of the response body (which may be nil or empty).\nThis is provided here as the raw response.Body() reader will have already\nbeen drained.", + "json_tag": "-" + }, + "RequestURL": { + "name": "RequestURL", + "description": "RequestURL is the request URL. This value is always available, even if the\nembedded *http.Response is nil.", + "json_tag": "url" + } + } + }, + "ApiAddNotesToAnOrderRequest": { + "type_name": "ApiAddNotesToAnOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "noteRequest": { + "name": "noteRequest", + "description": "" + }, + "orderId": { + "name": "orderId", + "description": "" + } + } + }, + "ApiCancelAnOrderRequest": { + "type_name": "ApiCancelAnOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "cancelRequest": { + "name": "cancelRequest", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "orderId": { + "name": "orderId", + "description": "" + } + } + }, + "ApiGETOrderDetailsRequest": { + "type_name": "ApiGETOrderDetailsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "ibxs": { + "name": "ibxs", + "description": "" + }, + "orderId": { + "name": "orderId", + "description": "" + } + } + }, + "ApiReplyToAnOrderNegotiationRequest": { + "type_name": "ApiReplyToAnOrderNegotiationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "negotiationsRequest": { + "name": "negotiationsRequest", + "description": "" + }, + "orderId": { + "name": "orderId", + "description": "" + } + } + }, + "ApiRetrieveOrderNegotiationsRequest": { + "type_name": "ApiRetrieveOrderNegotiationsRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "orderId": { + "name": "orderId", + "description": "" + } + } + }, + "Attachment": { + "type_name": "Attachment", + "description": "Attachment Attachments", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Id": { + "name": "Id", + "description": "Identifier of the binary attachment UUID.", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "Name of the binary attachment.", + "json_tag": "name" + } + } + }, + "BasicAuth": { + "type_name": "BasicAuth", + "description": "BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth", + "fields": { + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "UserName": { + "name": "UserName", + "description": "", + "json_tag": "userName" + } + } + }, + "CancelRequest": { + "type_name": "CancelRequest", + "description": "CancelRequest Cancelling the Order", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "File(s) attached", + "json_tag": "attachments" + }, + "LineIds": { + "name": "LineIds", + "description": "Refers to the `lineId` of product/service.", + "json_tag": "lineIds" + }, + "Reason": { + "name": "Reason", + "description": "Reason for cancellation", + "json_tag": "reason" + } + } + }, + "Configuration": { + "type_name": "Configuration", + "description": "Configuration stores the configuration of the API client", + "fields": { + "Debug": { + "name": "Debug", + "description": "", + "json_tag": "debug" + }, + "DefaultHeader": { + "name": "DefaultHeader", + "description": "", + "json_tag": "defaultHeader" + }, + "HTTPClient": { + "name": "HTTPClient", + "description": "" + }, + "Host": { + "name": "Host", + "description": "", + "json_tag": "host" + }, + "OperationServers": { + "name": "OperationServers", + "description": "" + }, + "Scheme": { + "name": "Scheme", + "description": "", + "json_tag": "scheme" + }, + "Servers": { + "name": "Servers", + "description": "" + }, + "UserAgent": { + "name": "UserAgent", + "description": "", + "json_tag": "userAgent" + } + } + }, + "Contacts": { + "type_name": "Contacts", + "description": "Contacts Contact information.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Availability": { + "name": "Availability", + "description": "", + "json_tag": "availability" + }, + "Details": { + "name": "Details", + "description": "Reference of the related party, could be a party reference or a party role reference", + "json_tag": "details" + }, + "FirstName": { + "name": "FirstName", + "description": "First name of the contact.", + "json_tag": "firstName" + }, + "LastName": { + "name": "LastName", + "description": "Last name of the contact.", + "json_tag": "lastName" + }, + "RegisteredUser": { + "name": "RegisteredUser", + "description": "Username of a registered user.", + "json_tag": "registeredUser" + }, + "Timezone": { + "name": "Timezone", + "description": "", + "json_tag": "timezone" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ContactsDetails": { + "type_name": "ContactsDetails", + "description": "ContactsDetails Contact information.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + }, + "Value": { + "name": "Value", + "description": "Value of contact details `type`", + "json_tag": "value" + } + } + }, + "ErrorDetails": { + "type_name": "ErrorDetails", + "description": "ErrorDetails struct for ErrorDetails", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CorrelationId": { + "name": "CorrelationId", + "description": "", + "json_tag": "correlationId" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "ErrorCode": { + "name": "ErrorCode", + "description": "", + "json_tag": "errorCode" + }, + "ErrorMessage": { + "name": "ErrorMessage", + "description": "", + "json_tag": "errorMessage" + }, + "Help": { + "name": "Help", + "description": "", + "json_tag": "help" + } + } + }, + "GenericOpenAPIError": { + "type_name": "GenericOpenAPIError", + "description": "GenericOpenAPIError Provides access to the body, error and model on returned errors.", + "fields": { + "body": { + "name": "body", + "description": "" + }, + "error": { + "name": "error", + "description": "" + }, + "model": { + "name": "model", + "description": "" + } + } + }, + "Negotiations": { + "type_name": "Negotiations", + "description": "Negotiations Negotiations message with alternative date and time", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Negotiations message created date and time by operations team", + "json_tag": "createdDateTime" + }, + "Expedited": { + "name": "Expedited", + "description": "When `true,` requested order is an expedite order", + "json_tag": "expedited" + }, + "ExpirationDateTime": { + "name": "ExpirationDateTime", + "description": "Validity date and time of the negotiation. Negotiations request after this date will no longer be valid.", + "json_tag": "expirationDateTime" + }, + "Message": { + "name": "Message", + "description": "Negotiations message", + "json_tag": "message" + }, + "OrderRequestedDateTime": { + "name": "OrderRequestedDateTime", + "description": "Customer requested order date and time at point of order.", + "json_tag": "orderRequestedDateTime" + }, + "ProposedDateTime": { + "name": "ProposedDateTime", + "description": "Alternative / revised date and time proposed by Equinix for fulfilling the order request.", + "json_tag": "proposedDateTime" + }, + "ReferenceId": { + "name": "ReferenceId", + "description": "Reference id / internal id for customer to identify the actionable order line", + "json_tag": "referenceId" + } + } + }, + "NegotiationsRequest": { + "type_name": "NegotiationsRequest", + "description": "NegotiationsRequest struct for NegotiationsRequest", + "fields": { + "Action": { + "name": "Action", + "description": "", + "json_tag": "action" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Reason": { + "name": "Reason", + "description": "Reason for cancelling the negotiation", + "json_tag": "reason" + }, + "ReferenceId": { + "name": "ReferenceId", + "description": "Unique identifier to reference specific activity or order line id.", + "json_tag": "referenceId" + } + } + }, + "Note": { + "type_name": "Note", + "description": "Note Extra information about a given entity", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "File(s) attached to the orders. To learn about including attachments in your request, refer to Attachments API.", + "json_tag": "attachments" + }, + "Author": { + "name": "Author", + "description": "Author of the notes", + "json_tag": "author" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "Date and time of the note creation in UTC timezone", + "json_tag": "createdDateTime" + }, + "Id": { + "name": "Id", + "description": "Unique identifier of the note", + "json_tag": "id" + }, + "ReferenceId": { + "name": "ReferenceId", + "description": "Unique identifier for referencing notes.", + "json_tag": "referenceId" + }, + "Text": { + "name": "Text", + "description": "The content of the note", + "json_tag": "text" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "NoteRequest": { + "type_name": "NoteRequest", + "description": "NoteRequest Extra notes about a given entity", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "File(s) attached to the Orders. To learn about including attachments in your request, see POST Attachments API.", + "json_tag": "attachments" + }, + "ReferenceId": { + "name": "ReferenceId", + "description": "Unique reference ID associated with notes.", + "json_tag": "referenceId" + }, + "Text": { + "name": "Text", + "description": "The text of the note", + "json_tag": "text" + } + } + }, + "NullableAttachment": { + "type_name": "NullableAttachment", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBool": { + "type_name": "NullableBool", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCancelRequest": { + "type_name": "NullableCancelRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContacts": { + "type_name": "NullableContacts", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactsAvailability": { + "type_name": "NullableContactsAvailability", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactsDetails": { + "type_name": "NullableContactsDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactsDetailsType": { + "type_name": "NullableContactsDetailsType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactsType": { + "type_name": "NullableContactsType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCurrencyCode": { + "type_name": "NullableCurrencyCode", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableErrorDetails": { + "type_name": "NullableErrorDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat32": { + "type_name": "NullableFloat32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat64": { + "type_name": "NullableFloat64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt": { + "type_name": "NullableInt", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt32": { + "type_name": "NullableInt32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt64": { + "type_name": "NullableInt64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNegotiations": { + "type_name": "NullableNegotiations", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNegotiationsRequest": { + "type_name": "NullableNegotiationsRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNegotiationsRequestAction": { + "type_name": "NullableNegotiationsRequestAction", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNote": { + "type_name": "NullableNote", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNoteRequest": { + "type_name": "NullableNoteRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableNoteType": { + "type_name": "NullableNoteType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderDetails": { + "type_name": "NullableOrderDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrders": { + "type_name": "NullableOrders", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrdersBase": { + "type_name": "NullableOrdersBase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrdersBaseChannel": { + "type_name": "NullableOrdersBaseChannel", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrdersBaseQuoteRequestType": { + "type_name": "NullableOrdersBaseQuoteRequestType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrdersBaseStatus": { + "type_name": "NullableOrdersBaseStatus", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrdersBaseSubChannel": { + "type_name": "NullableOrdersBaseSubChannel", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrdersLine": { + "type_name": "NullableOrdersLine", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrdersLineRequestType": { + "type_name": "NullableOrdersLineRequestType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePrice": { + "type_name": "NullablePrice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePriceValueType": { + "type_name": "NullablePriceValueType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProductAdditionalInfoInner": { + "type_name": "NullableProductAdditionalInfoInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePurchaseOrder": { + "type_name": "NullablePurchaseOrder", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePurchaseOrderType": { + "type_name": "NullablePurchaseOrderType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableString": { + "type_name": "NullableString", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTIMEZONELIST": { + "type_name": "NullableTIMEZONELIST", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTime": { + "type_name": "NullableTime", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "OrderDetails": { + "type_name": "OrderDetails", + "description": "OrderDetails struct for OrderDetails", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + } + } + }, + "Orders": { + "type_name": "Orders", + "description": "Orders An order could be request, service or ticket to performs specified activity on an colo businesss", + "fields": { + "AccountName": { + "name": "AccountName", + "description": "Customer account name", + "json_tag": "accountName" + }, + "AccountNumber": { + "name": "AccountNumber", + "description": "Customer account number", + "json_tag": "accountNumber" + }, + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "This section is reserved to display product specific information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cancellable": { + "name": "Cancellable", + "description": "When `true`, order can be cancelled.", + "json_tag": "cancellable" + }, + "Channel": { + "name": "Channel", + "description": "", + "json_tag": "channel" + }, + "ClosedDateTime": { + "name": "ClosedDateTime", + "description": "The order closed date and time in UTC timezone.", + "json_tag": "closedDateTime" + }, + "Contacts": { + "name": "Contacts", + "description": "The related party associated with the ticket.", + "json_tag": "contacts" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "The order created date and time in UTC timezone.", + "json_tag": "createdDateTime" + }, + "CurrencyCode": { + "name": "CurrencyCode", + "description": "", + "json_tag": "currencyCode" + }, + "CustomerReferenceId": { + "name": "CustomerReferenceId", + "description": "Customer Reference Number / External Reference Number", + "json_tag": "customerReferenceId" + }, + "Details": { + "name": "Details", + "description": "", + "json_tag": "details" + }, + "EstimatedCompletionDateTime": { + "name": "EstimatedCompletionDateTime", + "description": "The estimated completion date and time in UTC timezone", + "json_tag": "estimatedCompletionDateTime" + }, + "Modifiable": { + "name": "Modifiable", + "description": "When `true`, order can be modified.", + "json_tag": "modifiable" + }, + "Notes": { + "name": "Notes", + "description": "The notes that are associated to the orders.", + "json_tag": "notes" + }, + "OrderId": { + "name": "OrderId", + "description": "Unique identifier of the order.", + "json_tag": "orderId" + }, + "QuoteRequestType": { + "name": "QuoteRequestType", + "description": "", + "json_tag": "quoteRequestType" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "SubChannel": { + "name": "SubChannel", + "description": "", + "json_tag": "subChannel" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "The order updated date and time in UTC timezone.", + "json_tag": "updatedDateTime" + } + } + }, + "OrdersBase": { + "type_name": "OrdersBase", + "description": "OrdersBase Orders Base is the properties or attributes which common for every order details", + "fields": { + "AccountName": { + "name": "AccountName", + "description": "Customer account name", + "json_tag": "accountName" + }, + "AccountNumber": { + "name": "AccountNumber", + "description": "Customer account number", + "json_tag": "accountNumber" + }, + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "This section is reserved to display product specific information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cancellable": { + "name": "Cancellable", + "description": "When `true`, order can be cancelled.", + "json_tag": "cancellable" + }, + "Channel": { + "name": "Channel", + "description": "", + "json_tag": "channel" + }, + "ClosedDateTime": { + "name": "ClosedDateTime", + "description": "The order closed date and time in UTC timezone.", + "json_tag": "closedDateTime" + }, + "Contacts": { + "name": "Contacts", + "description": "The related party associated with the ticket.", + "json_tag": "contacts" + }, + "CreatedDateTime": { + "name": "CreatedDateTime", + "description": "The order created date and time in UTC timezone.", + "json_tag": "createdDateTime" + }, + "CurrencyCode": { + "name": "CurrencyCode", + "description": "", + "json_tag": "currencyCode" + }, + "CustomerReferenceId": { + "name": "CustomerReferenceId", + "description": "Customer Reference Number / External Reference Number", + "json_tag": "customerReferenceId" + }, + "EstimatedCompletionDateTime": { + "name": "EstimatedCompletionDateTime", + "description": "The estimated completion date and time in UTC timezone", + "json_tag": "estimatedCompletionDateTime" + }, + "Modifiable": { + "name": "Modifiable", + "description": "When `true`, order can be modified.", + "json_tag": "modifiable" + }, + "Notes": { + "name": "Notes", + "description": "The notes that are associated to the orders.", + "json_tag": "notes" + }, + "OrderId": { + "name": "OrderId", + "description": "Unique identifier of the order.", + "json_tag": "orderId" + }, + "QuoteRequestType": { + "name": "QuoteRequestType", + "description": "", + "json_tag": "quoteRequestType" + }, + "Status": { + "name": "Status", + "description": "", + "json_tag": "status" + }, + "SubChannel": { + "name": "SubChannel", + "description": "", + "json_tag": "subChannel" + }, + "UpdatedDateTime": { + "name": "UpdatedDateTime", + "description": "The order updated date and time in UTC timezone.", + "json_tag": "updatedDateTime" + } + } + }, + "OrdersLine": { + "type_name": "OrdersLine", + "description": "OrdersLine Orders Line contains information appplicable for all the orders type i.e smart hands, work visit and cross connect", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "This section is reserved to display product specific information", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "File(s) attached to the Orders. To learn about including attachments in your request, see POST Attachments API.", + "json_tag": "attachments" + }, + "BillingStartDateTime": { + "name": "BillingStartDateTime", + "description": "Billing commencement date and time in UTC provided in the RFC3339 format with timezone markers omitted, delimitting date and time with a space, e.g. 2024-12-31 23:59:59", + "json_tag": "billingStartDateTime" + }, + "Cabinets": { + "name": "Cabinets", + "description": "One or more cabinets ID", + "json_tag": "cabinets" + }, + "Cage": { + "name": "Cage", + "description": "Cage ID", + "json_tag": "cage" + }, + "Cancellable": { + "name": "Cancellable", + "description": "When `true`, order can be cancelled", + "json_tag": "cancellable" + }, + "Description": { + "name": "Description", + "description": "Description of the orders.", + "json_tag": "description" + }, + "EstimatedCompletionDateTime": { + "name": "EstimatedCompletionDateTime", + "description": "The estimated completion date and time in UTC timezone", + "json_tag": "estimatedCompletionDateTime" + }, + "Ibx": { + "name": "Ibx", + "description": "Location code of Equinix datacenter", + "json_tag": "ibx" + }, + "LineId": { + "name": "LineId", + "description": "Unique identifier associated with line item.", + "json_tag": "lineId" + }, + "Modifiable": { + "name": "Modifiable", + "description": "When `true`, order can be modified", + "json_tag": "modifiable" + }, + "ParentlineId": { + "name": "ParentlineId", + "description": "Unique identifier associated with `lineId`to denote hierarchy of the product. When this field is null, item considered to be at root level.", + "json_tag": "parentlineId" + }, + "ProductCode": { + "name": "ProductCode", + "description": "Product code associated with a particular product", + "json_tag": "productCode" + }, + "ProductName": { + "name": "ProductName", + "description": "Product name", + "json_tag": "productName" + }, + "ProductType": { + "name": "ProductType", + "description": "Type of product. Known values include: CROSS_CONNECT, SMART_HANDS, WORK_VISIT, SECURITY_ACCESS, CONFERENCE_ROOM, TROUBLE_TICKET, SHIPMENTS, NETWORK_PORTS, DEINSTALL_CROSS_CONNECT, Equinix Fabric Port/Connection, OTHER", + "json_tag": "productType" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "RequestType": { + "name": "RequestType", + "description": "", + "json_tag": "requestType" + }, + "RootlineId": { + "name": "RootlineId", + "description": "Unique identifier to specify root item. Useful when product order hierarchy exceeds 2.", + "json_tag": "rootlineId" + }, + "Status": { + "name": "Status", + "description": "The current status of the order or service", + "json_tag": "status" + }, + "TotalPricing": { + "name": "TotalPricing", + "description": "Total Pricing details", + "json_tag": "totalPricing" + }, + "UnitPricing": { + "name": "UnitPricing", + "description": "Unit Pricing details", + "json_tag": "unitPricing" + } + } + }, + "Price": { + "type_name": "Price", + "description": "Price Pricing details for a particular service or order, This can be one time charge or recurring charge", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Type": { + "name": "Type", + "description": "To indicate the type of `value` and `valueType`. Known values include: ONE_TIME_CHARGE, MONTHLY_CHARGE, MONTHLY_DISCOUNT, ONE_TIME_DISCOUNT, NET_MONTHLY_CHARGE, NET_ONE_TIME_CHARGE", + "json_tag": "type" + }, + "Value": { + "name": "Value", + "description": "To be used with `valueType` and `type`. Can be used to denote price or discount for an order or service", + "json_tag": "value" + }, + "ValueType": { + "name": "ValueType", + "description": "", + "json_tag": "valueType" + } + } + }, + "ProductAdditionalInfoInner": { + "type_name": "ProductAdditionalInfoInner", + "description": "ProductAdditionalInfoInner struct for ProductAdditionalInfoInner", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Key": { + "name": "Key", + "description": "", + "json_tag": "key" + }, + "Value": { + "name": "Value", + "description": "", + "json_tag": "value" + } + } + }, + "PurchaseOrder": { + "type_name": "PurchaseOrder", + "description": "PurchaseOrder Purchase Order", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ClosingDate": { + "name": "ClosingDate", + "description": "Closing date of purchase order.", + "json_tag": "closingDate" + }, + "Number": { + "name": "Number", + "description": "Purchase order number", + "json_tag": "number" + }, + "Type": { + "name": "Type", + "description": "", + "json_tag": "type" + } + } + }, + "ServerConfiguration": { + "type_name": "ServerConfiguration", + "description": "ServerConfiguration stores the information about a server", + "fields": { + "Description": { + "name": "Description", + "description": "" + }, + "URL": { + "name": "URL", + "description": "" + }, + "Variables": { + "name": "Variables", + "description": "" + } + } + }, + "ServerVariable": { + "type_name": "ServerVariable", + "description": "ServerVariable stores the information about a server variable", + "fields": { + "DefaultValue": { + "name": "DefaultValue", + "description": "" + }, + "Description": { + "name": "Description", + "description": "" + }, + "EnumValues": { + "name": "EnumValues", + "description": "" + } + } + }, + "formFile": { + "type_name": "formFile", + "fields": { + "fileBytes": { + "name": "fileBytes", + "description": "" + }, + "fileName": { + "name": "fileName", + "description": "" + }, + "formFileName": { + "name": "formFileName", + "description": "" + } + } + }, + "service": { + "type_name": "service", + "fields": { + "client": { + "name": "client", + "description": "" + } + } + } + } +} \ No newline at end of file diff --git a/cmd/descriptions/securecabinetv1.json b/cmd/descriptions/securecabinetv1.json new file mode 100644 index 0000000..76f6f86 --- /dev/null +++ b/cmd/descriptions/securecabinetv1.json @@ -0,0 +1,1104 @@ +{ + "services": { + "availability": { + "service_name": "availability", + "service_description": "", + "methods": { + "GetProductsAvailability": { + "short_description": "Secure Cabinet availability.", + "long_description": "Returns the availability of Secure Cabinets and recommended additional products for provided billing account.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + }, + { + "name": "accountNumber", + "description": "Billing Account Number." + } + ] + }, + "GetProductsAvailabilityExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGetProductsAvailabilityRequest": { + "type_name": "ApiGetProductsAvailabilityRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "accountNumber": { + "name": "accountNumber", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + } + } + }, + "orders": { + "service_name": "orders", + "service_description": "", + "methods": { + "CreateOrder": { + "short_description": "Order a new Secure Cabinet deployment", + "long_description": "Order a new Secure Cabinet deployment and recommended additional products at IBX data centers worldwide.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "CreateOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiCreateOrderRequest": { + "type_name": "ApiCreateOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "orderCreateRequest": { + "name": "orderCreateRequest", + "description": "" + } + } + } + } + } + }, + "types": { + "APIClient": { + "type_name": "APIClient", + "description": "APIClient manages communication with the Secure Cabinet API API v1.0.0\nIn most cases there should be only one, shared, APIClient.", + "fields": { + "AvailabilityApi": { + "name": "AvailabilityApi", + "description": "" + }, + "OrdersApi": { + "name": "OrdersApi", + "description": "" + }, + "cfg": { + "name": "cfg", + "description": "" + }, + "common": { + "name": "common", + "description": "Reuse a single struct instead of allocating one for each service on the heap." + } + } + }, + "APIKey": { + "type_name": "APIKey", + "description": "APIKey provides API key based authentication to a request passed via context using ContextAPIKey", + "fields": { + "Key": { + "name": "Key", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "" + } + } + }, + "APIResponse": { + "type_name": "APIResponse", + "description": "APIResponse stores the API response returned by the server.", + "fields": { + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "Method": { + "name": "Method", + "description": "Method is the HTTP method used for the request. This value is always\navailable, even if the embedded *http.Response is nil.", + "json_tag": "method" + }, + "Operation": { + "name": "Operation", + "description": "Operation is the name of the OpenAPI operation.", + "json_tag": "operation" + }, + "Payload": { + "name": "Payload", + "description": "Payload holds the contents of the response body (which may be nil or empty).\nThis is provided here as the raw response.Body() reader will have already\nbeen drained.", + "json_tag": "-" + }, + "RequestURL": { + "name": "RequestURL", + "description": "RequestURL is the request URL. This value is always available, even if the\nembedded *http.Response is nil.", + "json_tag": "url" + } + } + }, + "AcCircuitConfig": { + "type_name": "AcCircuitConfig", + "description": "AcCircuitConfig struct for AcCircuitConfig", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Phase": { + "name": "Phase", + "description": "", + "json_tag": "phase" + }, + "Receptacle": { + "name": "Receptacle", + "description": "Receptacle type", + "json_tag": "receptacle" + }, + "SoldAmperage": { + "name": "SoldAmperage", + "description": "Amperage Numerical Value", + "json_tag": "soldAmperage" + }, + "Voltage": { + "name": "Voltage", + "description": "Voltage numerical value", + "json_tag": "voltage" + } + } + }, + "ApiCreateOrderRequest": { + "type_name": "ApiCreateOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "orderCreateRequest": { + "name": "orderCreateRequest", + "description": "" + } + } + }, + "ApiGetProductsAvailabilityRequest": { + "type_name": "ApiGetProductsAvailabilityRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "accountNumber": { + "name": "accountNumber", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "BasicAuth": { + "type_name": "BasicAuth", + "description": "BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth", + "fields": { + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "UserName": { + "name": "UserName", + "description": "", + "json_tag": "userName" + } + } + }, + "Configuration": { + "type_name": "Configuration", + "description": "Configuration stores the configuration of the API client", + "fields": { + "Debug": { + "name": "Debug", + "description": "", + "json_tag": "debug" + }, + "DefaultHeader": { + "name": "DefaultHeader", + "description": "", + "json_tag": "defaultHeader" + }, + "HTTPClient": { + "name": "HTTPClient", + "description": "" + }, + "Host": { + "name": "Host", + "description": "", + "json_tag": "host" + }, + "OperationServers": { + "name": "OperationServers", + "description": "" + }, + "Scheme": { + "name": "Scheme", + "description": "", + "json_tag": "scheme" + }, + "Servers": { + "name": "Servers", + "description": "" + }, + "UserAgent": { + "name": "UserAgent", + "description": "", + "json_tag": "userAgent" + } + } + }, + "ContactDetails": { + "type_name": "ContactDetails", + "description": "ContactDetails Contact person details for technical inquiries.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Email": { + "name": "Email", + "description": "Email address.", + "json_tag": "email" + }, + "FirstName": { + "name": "FirstName", + "description": "First name.", + "json_tag": "firstName" + }, + "LastName": { + "name": "LastName", + "description": "Last name.", + "json_tag": "lastName" + }, + "Phone": { + "name": "Phone", + "description": "", + "json_tag": "phone" + } + } + }, + "Dimension": { + "type_name": "Dimension", + "description": "Dimension struct for Dimension", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Unit": { + "name": "Unit", + "description": "", + "json_tag": "unit" + }, + "Value": { + "name": "Value", + "description": "Dimension Value", + "json_tag": "value" + } + } + }, + "Dimensions": { + "type_name": "Dimensions", + "description": "Dimensions struct for Dimensions", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Depth": { + "name": "Depth", + "description": "", + "json_tag": "depth" + }, + "Height": { + "name": "Height", + "description": "", + "json_tag": "height" + }, + "Width": { + "name": "Width", + "description": "", + "json_tag": "width" + } + } + }, + "Error": { + "type_name": "Error", + "description": "Error Error responses are included with 4xx and 5xx HTTP responses from the API service. Either \\\"error\\\" or \\\"errors\\\" will be set.", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Contains application specific information for this error. The object inside this array can have any number of application specific properties.", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CorrelationId": { + "name": "CorrelationId", + "description": "Correlation ID without any sensitive or meaningful information.", + "json_tag": "correlationId" + }, + "Details": { + "name": "Details", + "description": "More information on errors.", + "json_tag": "details" + }, + "ErrorCode": { + "name": "ErrorCode", + "description": "Application error code. Format :EQ-\u003cerror code\u003e", + "json_tag": "errorCode\" validate:\"regexp=^EQ-70[0-9]{5}$" + }, + "ErrorMessage": { + "name": "ErrorMessage", + "description": "Application error message", + "json_tag": "errorMessage" + }, + "Help": { + "name": "Help", + "description": "Help message or URL to a help page for the corresponding errorCode.", + "json_tag": "help" + } + } + }, + "ErrorAdditionalInfo": { + "type_name": "ErrorAdditionalInfo", + "description": "ErrorAdditionalInfo struct for ErrorAdditionalInfo", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Property": { + "name": "Property", + "description": "Property at which the error occurs. Can be empty.", + "json_tag": "property" + }, + "Reason": { + "name": "Reason", + "description": "Fallback error message in plain English.", + "json_tag": "reason" + } + } + }, + "GenericOpenAPIError": { + "type_name": "GenericOpenAPIError", + "description": "GenericOpenAPIError Provides access to the body, error and model on returned errors.", + "fields": { + "body": { + "name": "body", + "description": "" + }, + "error": { + "name": "error", + "description": "" + }, + "model": { + "name": "model", + "description": "" + } + } + }, + "NullableAcCircuitConfig": { + "type_name": "NullableAcCircuitConfig", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBool": { + "type_name": "NullableBool", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactAvailability": { + "type_name": "NullableContactAvailability", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactDetails": { + "type_name": "NullableContactDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContractTerm": { + "type_name": "NullableContractTerm", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDimension": { + "type_name": "NullableDimension", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDimensionUnit": { + "type_name": "NullableDimensionUnit", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDimensions": { + "type_name": "NullableDimensions", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableError": { + "type_name": "NullableError", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableErrorAdditionalInfo": { + "type_name": "NullableErrorAdditionalInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFabricPortSpeed": { + "type_name": "NullableFabricPortSpeed", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat32": { + "type_name": "NullableFloat32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat64": { + "type_name": "NullableFloat64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt": { + "type_name": "NullableInt", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt32": { + "type_name": "NullableInt32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt64": { + "type_name": "NullableInt64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderCreateRequest": { + "type_name": "NullableOrderCreateRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderCreateResponse": { + "type_name": "NullableOrderCreateResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOrderItem": { + "type_name": "NullableOrderItem", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePduConfig": { + "type_name": "NullablePduConfig", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePhase": { + "type_name": "NullablePhase", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePhone": { + "type_name": "NullablePhone", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableProductsAvailability": { + "type_name": "NullableProductsAvailability", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableString": { + "type_name": "NullableString", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTime": { + "type_name": "NullableTime", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableValidationError": { + "type_name": "NullableValidationError", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableValidationErrorAdditionalInfo": { + "type_name": "NullableValidationErrorAdditionalInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "OrderCreateRequest": { + "type_name": "OrderCreateRequest", + "description": "OrderCreateRequest struct for OrderCreateRequest", + "fields": { + "AccountNumber": { + "name": "AccountNumber", + "description": "Identifier of a billing account, with permission to order colocation products.", + "json_tag": "accountNumber" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ContractTerm": { + "name": "ContractTerm", + "description": "", + "json_tag": "contractTerm" + }, + "CustomerReference": { + "name": "CustomerReference", + "description": "Supplementary identifier for your discretionary use. For example, your internal identifier.", + "json_tag": "customerReference" + }, + "EndCustomerName": { + "name": "EndCustomerName", + "description": "End customer name. Applicable and required if a reseller billing account is used.", + "json_tag": "endCustomerName" + }, + "IbxCode": { + "name": "IbxCode", + "description": "IBX data center identifier.", + "json_tag": "ibxCode\" validate:\"regexp=^[A-Z]{2}[0-9]+x?$" + }, + "OrderItem": { + "name": "OrderItem", + "description": "", + "json_tag": "orderItem" + }, + "PurchaseOrderNumber": { + "name": "PurchaseOrderNumber", + "description": "Purchase order number. Optional, unless the billing account requires it.", + "json_tag": "purchaseOrderNumber" + }, + "TechnicalContact": { + "name": "TechnicalContact", + "description": "", + "json_tag": "technicalContact" + } + } + }, + "OrderCreateResponse": { + "type_name": "OrderCreateResponse", + "description": "OrderCreateResponse struct for OrderCreateResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "OrderNumber": { + "name": "OrderNumber", + "description": "Order Number", + "json_tag": "orderNumber" + } + } + }, + "OrderItem": { + "type_name": "OrderItem", + "description": "OrderItem Order details.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CabinetDimensions": { + "name": "CabinetDimensions", + "description": "", + "json_tag": "cabinetDimensions" + }, + "DrawCapacity": { + "name": "DrawCapacity", + "description": "Maximum, combined power draw of all cabinets in your order, measured in kVA. Applicable values, in 0.5 increments, depend on the IBX data center.", + "json_tag": "drawCapacity" + }, + "FabricPort": { + "name": "FabricPort", + "description": "Indicates if a single, primary Fabric port should be included and delivered to one of the ordered cabinets.", + "json_tag": "fabricPort" + }, + "NumberOfCabinets": { + "name": "NumberOfCabinets", + "description": "The number of ordered cabinets.", + "json_tag": "numberOfCabinets" + }, + "Pdus": { + "name": "Pdus", + "description": "Indicates if an Equinix-recommended set of two PDUs, for single-phase circuit, per cabinet should be installed.", + "json_tag": "pdus" + } + } + }, + "PduConfig": { + "type_name": "PduConfig", + "description": "PduConfig struct for PduConfig", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Model": { + "name": "Model", + "description": "Model Code", + "json_tag": "model" + } + } + }, + "Phone": { + "type_name": "Phone", + "description": "Phone Phone number details.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Availability": { + "name": "Availability", + "description": "", + "json_tag": "availability" + }, + "Number": { + "name": "Number", + "description": "A phone number in full international format.", + "json_tag": "number" + } + } + }, + "ProductsAvailability": { + "type_name": "ProductsAvailability", + "description": "ProductsAvailability Information about availability of products in one ibx. Missing pdu configuration means that we don't offer pdu there. Missing fabric port speed means that fabric port is not available there.", + "fields": { + "AcCircuitConfiguration": { + "name": "AcCircuitConfiguration", + "description": "", + "json_tag": "acCircuitConfiguration" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CabinetDimensions": { + "name": "CabinetDimensions", + "description": "", + "json_tag": "cabinetDimensions" + }, + "FabricPortSpeed": { + "name": "FabricPortSpeed", + "description": "", + "json_tag": "fabricPortSpeed" + }, + "Ibx": { + "name": "Ibx", + "description": "IBX data center identifier.", + "json_tag": "ibx\" validate:\"regexp=^[A-Z]{2}[0-9]+x?$" + }, + "MaximumDrawCapacityPerCabinet": { + "name": "MaximumDrawCapacityPerCabinet", + "description": "The maximum power draw capacity per ordered cabinet.", + "json_tag": "maximumDrawCapacityPerCabinet" + }, + "MaximumNumberOfCabinetsToOrder": { + "name": "MaximumNumberOfCabinetsToOrder", + "description": "Maximum number of cabinets that can be ordered in one order in this ibx.", + "json_tag": "maximumNumberOfCabinetsToOrder" + }, + "MinimumDrawCapacityPerCabinet": { + "name": "MinimumDrawCapacityPerCabinet", + "description": "The minimum power draw capacity per ordered cabinet.", + "json_tag": "minimumDrawCapacityPerCabinet" + }, + "PduConfiguration": { + "name": "PduConfiguration", + "description": "", + "json_tag": "pduConfiguration" + } + } + }, + "ServerConfiguration": { + "type_name": "ServerConfiguration", + "description": "ServerConfiguration stores the information about a server", + "fields": { + "Description": { + "name": "Description", + "description": "" + }, + "URL": { + "name": "URL", + "description": "" + }, + "Variables": { + "name": "Variables", + "description": "" + } + } + }, + "ServerVariable": { + "type_name": "ServerVariable", + "description": "ServerVariable stores the information about a server variable", + "fields": { + "DefaultValue": { + "name": "DefaultValue", + "description": "" + }, + "Description": { + "name": "Description", + "description": "" + }, + "EnumValues": { + "name": "EnumValues", + "description": "" + } + } + }, + "ValidationError": { + "type_name": "ValidationError", + "description": "ValidationError Error responses are included with 4xx and 5xx HTTP responses from the API service. Either \\\"error\\\" or \\\"errors\\\" will be set.", + "fields": { + "AdditionalInfo": { + "name": "AdditionalInfo", + "description": "Contains application specific information for this error. The object inside this array can have any number of application specific properties.", + "json_tag": "additionalInfo" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CorrelationId": { + "name": "CorrelationId", + "description": "Correlation ID without any sensitive or meaningful information.", + "json_tag": "correlationId" + }, + "Details": { + "name": "Details", + "description": "More information on errors.", + "json_tag": "details" + }, + "ErrorCode": { + "name": "ErrorCode", + "description": "Application error code. Format :EQ-\u003cerror code\u003e", + "json_tag": "errorCode" + }, + "ErrorMessage": { + "name": "ErrorMessage", + "description": "Application error message", + "json_tag": "errorMessage" + }, + "Help": { + "name": "Help", + "description": "Help message or URL to a help page for the corresponding errorCode.", + "json_tag": "help" + } + } + }, + "ValidationErrorAdditionalInfo": { + "type_name": "ValidationErrorAdditionalInfo", + "description": "ValidationErrorAdditionalInfo struct for ValidationErrorAdditionalInfo", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Property": { + "name": "Property", + "description": "Property at which the validation violation occurs. Can be empty when validation happens at the object top level.", + "json_tag": "property" + }, + "Reason": { + "name": "Reason", + "description": "Fallback error message in plain English.", + "json_tag": "reason" + }, + "ValidationParameters": { + "name": "ValidationParameters", + "description": "A map containing additional violation parameters, these can be used to render localized error messages. The list of available parameters is different for each validationRuleTag.", + "json_tag": "validationParameters" + }, + "ValidationRoot": { + "name": "ValidationRoot", + "description": "Name of the object at which the validation violation occurs. Can be empty when validation happens inline at the request params.", + "json_tag": "validationRoot" + }, + "ValidationRuleTag": { + "name": "ValidationRuleTag", + "description": "Violated validation rule tag.", + "json_tag": "validationRuleTag" + } + } + }, + "formFile": { + "type_name": "formFile", + "fields": { + "fileBytes": { + "name": "fileBytes", + "description": "" + }, + "fileName": { + "name": "fileName", + "description": "" + }, + "formFileName": { + "name": "formFileName", + "description": "" + } + } + }, + "service": { + "type_name": "service", + "fields": { + "client": { + "name": "client", + "description": "" + } + } + } + } +} \ No newline at end of file diff --git a/cmd/descriptions/smarthandsv1.json b/cmd/descriptions/smarthandsv1.json new file mode 100644 index 0000000..9bb58f6 --- /dev/null +++ b/cmd/descriptions/smarthandsv1.json @@ -0,0 +1,3232 @@ +{ + "services": { + "smarthands": { + "service_name": "smarthands", + "service_description": "", + "methods": { + "GetLocation": { + "short_description": "Get locations(ibx, cage) details for placing smart hands based on smart hands permission for user", + "long_description": "Get locations(ibx, cage) details for placing smart hands based on smart hands permission for user", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "GetLocationExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandCableRequestOrder": { + "short_description": "This API is used to request cables per your specifications for your equipment.", + "long_description": "This API is used to request cables per your specifications for your equipment.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandCableRequestOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandCageCleanupOrder": { + "short_description": "Request trash removal or cage cleanup", + "long_description": "This API is used to request trash removal or cage cleanup", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandCageCleanupOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandCageEscortOrder": { + "short_description": "Request a patch cable to be moved between devices", + "long_description": "This API is used to request a patch cable to be moved between devices", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandCageEscortOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandLocatePackageOrder": { + "short_description": "Get the location of your package(s) at an IBX.", + "long_description": "This API is used to get the location of your package(s) at an IBX.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandLocatePackageOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandMoveJumperCableOrder": { + "short_description": "This API is used to request a patch cable to be moved between devices.", + "long_description": "This API is used to request a patch cable to be moved between devices.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandMoveJumperCableOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandOrder": { + "short_description": "Request equipment installation per your specifications by an IBX Technician", + "long_description": "Request equipment installation per your specifications by an IBX Technician", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandOthersOrder": { + "short_description": "Request a Smart Hands order not listed in catalogue", + "long_description": "This API is used to request a Smart Hands order not listed in catalogue", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandOthersOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandPatchCableInstallOrder": { + "short_description": "Request installation of a cross connect patch cable by an IBX Technician.", + "long_description": "Request installation of a cross connect patch cable by an IBX Technician.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandPatchCableInstallOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandPatchCableRemovalOrder": { + "short_description": "Request removal of a cross connect cable by an IBX Technician.", + "long_description": "Request removal of a cross connect cable by an IBX Technician.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandPatchCableRemovalOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandPicturesDocumentOrder": { + "short_description": "Request an IBX Technician to provide cage-related pictures or documentation.", + "long_description": "Request an IBX Technician to provide cage-related pictures or documentation.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandPicturesDocumentOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandRunJumperCableOrder": { + "short_description": "This API is used to request a jumper cable to be ran between devices.", + "long_description": "This API is used to request a jumper cable to be ran between devices.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandRunJumperCableOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "HandleSmartHandShipmentUnpackOrder": { + "short_description": "Request inbound shipment unpacking and packaging disposal.", + "long_description": "This API is used to request inbound shipment unpacking and packaging disposal.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "HandleSmartHandShipmentUnpackOrderExecute": { + "short_description": "Execute executes the request", + "long_description": "" + }, + "SmartHandTypes": { + "short_description": "All supported smart hands types API.", + "long_description": "Smart Hands Types API provides all types of supported smart hands.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "SmartHandTypesExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiGetLocationRequest": { + "type_name": "ApiGetLocationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "cages": { + "name": "cages", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "detail": { + "name": "detail", + "description": "" + }, + "ibxs": { + "name": "ibxs", + "description": "" + } + } + }, + "ApiHandleSmartHandCableRequestOrderRequest": { + "type_name": "ApiHandleSmartHandCableRequestOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandCageCleanupOrderRequest": { + "type_name": "ApiHandleSmartHandCageCleanupOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandCageEscortOrderRequest": { + "type_name": "ApiHandleSmartHandCageEscortOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandLocatePackageOrderRequest": { + "type_name": "ApiHandleSmartHandLocatePackageOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandMoveJumperCableOrderRequest": { + "type_name": "ApiHandleSmartHandMoveJumperCableOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandOrderRequest": { + "type_name": "ApiHandleSmartHandOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandOthersOrderRequest": { + "type_name": "ApiHandleSmartHandOthersOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandPatchCableInstallOrderRequest": { + "type_name": "ApiHandleSmartHandPatchCableInstallOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandPatchCableRemovalOrderRequest": { + "type_name": "ApiHandleSmartHandPatchCableRemovalOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandPicturesDocumentOrderRequest": { + "type_name": "ApiHandleSmartHandPicturesDocumentOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandRunJumperCableOrderRequest": { + "type_name": "ApiHandleSmartHandRunJumperCableOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandShipmentUnpackOrderRequest": { + "type_name": "ApiHandleSmartHandShipmentUnpackOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiSmartHandTypesRequest": { + "type_name": "ApiSmartHandTypesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + } + } + } + }, + "types": { + "APIClient": { + "type_name": "APIClient", + "description": "APIClient manages communication with the Smart Hands API v1.0\nIn most cases there should be only one, shared, APIClient.", + "fields": { + "SmarthandsApi": { + "name": "SmarthandsApi", + "description": "" + }, + "cfg": { + "name": "cfg", + "description": "" + }, + "common": { + "name": "common", + "description": "Reuse a single struct instead of allocating one for each service on the heap." + } + } + }, + "APIKey": { + "type_name": "APIKey", + "description": "APIKey provides API key based authentication to a request passed via context using ContextAPIKey", + "fields": { + "Key": { + "name": "Key", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "" + } + } + }, + "APIResponse": { + "type_name": "APIResponse", + "description": "APIResponse stores the API response returned by the server.", + "fields": { + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "Method": { + "name": "Method", + "description": "Method is the HTTP method used for the request. This value is always\navailable, even if the embedded *http.Response is nil.", + "json_tag": "method" + }, + "Operation": { + "name": "Operation", + "description": "Operation is the name of the OpenAPI operation.", + "json_tag": "operation" + }, + "Payload": { + "name": "Payload", + "description": "Payload holds the contents of the response body (which may be nil or empty).\nThis is provided here as the raw response.Body() reader will have already\nbeen drained.", + "json_tag": "-" + }, + "RequestURL": { + "name": "RequestURL", + "description": "RequestURL is the request URL. This value is always available, even if the\nembedded *http.Response is nil.", + "json_tag": "url" + } + } + }, + "Account": { + "type_name": "Account", + "description": "Account struct for Account", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cabinets": { + "name": "Cabinets", + "description": "List of Cabinets", + "json_tag": "cabinets" + }, + "IsCreditHold": { + "name": "IsCreditHold", + "description": "Is credit Hold account", + "json_tag": "isCreditHold" + }, + "IsPOBearing": { + "name": "IsPOBearing", + "description": "Is PO Bearing account", + "json_tag": "isPOBearing" + }, + "Name": { + "name": "Name", + "description": "Name of Account", + "json_tag": "name" + }, + "Number": { + "name": "Number", + "description": "Account Number", + "json_tag": "number" + } + } + }, + "ApiGetLocationRequest": { + "type_name": "ApiGetLocationRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "cages": { + "name": "cages", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "detail": { + "name": "detail", + "description": "" + }, + "ibxs": { + "name": "ibxs", + "description": "" + } + } + }, + "ApiHandleSmartHandCableRequestOrderRequest": { + "type_name": "ApiHandleSmartHandCableRequestOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandCageCleanupOrderRequest": { + "type_name": "ApiHandleSmartHandCageCleanupOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandCageEscortOrderRequest": { + "type_name": "ApiHandleSmartHandCageEscortOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandLocatePackageOrderRequest": { + "type_name": "ApiHandleSmartHandLocatePackageOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandMoveJumperCableOrderRequest": { + "type_name": "ApiHandleSmartHandMoveJumperCableOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandOrderRequest": { + "type_name": "ApiHandleSmartHandOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandOthersOrderRequest": { + "type_name": "ApiHandleSmartHandOthersOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandPatchCableInstallOrderRequest": { + "type_name": "ApiHandleSmartHandPatchCableInstallOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandPatchCableRemovalOrderRequest": { + "type_name": "ApiHandleSmartHandPatchCableRemovalOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandPicturesDocumentOrderRequest": { + "type_name": "ApiHandleSmartHandPicturesDocumentOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandRunJumperCableOrderRequest": { + "type_name": "ApiHandleSmartHandRunJumperCableOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiHandleSmartHandShipmentUnpackOrderRequest": { + "type_name": "ApiHandleSmartHandShipmentUnpackOrderRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "body": { + "name": "body", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "ApiSmartHandTypesRequest": { + "type_name": "ApiSmartHandTypesRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "authorization": { + "name": "authorization", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + } + } + }, + "Attachment": { + "type_name": "Attachment", + "description": "Attachment struct for Attachment", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Id": { + "name": "Id", + "description": "Attachement Id generated from Attachment Api", + "json_tag": "id" + }, + "Name": { + "name": "Name", + "description": "Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api", + "json_tag": "name" + } + } + }, + "BasicAuth": { + "type_name": "BasicAuth", + "description": "BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth", + "fields": { + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "UserName": { + "name": "UserName", + "description": "", + "json_tag": "userName" + } + } + }, + "Cabinets": { + "type_name": "Cabinets", + "description": "Cabinets struct for Cabinets", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cabinet": { + "name": "Cabinet", + "description": "Cabinet Number", + "json_tag": "cabinet" + }, + "CabinetType": { + "name": "CabinetType", + "description": "Cabinet Type, Eg. Regular, Demarc", + "json_tag": "cabinetType" + } + } + }, + "CableRequestRequest": { + "type_name": "CableRequestRequest", + "description": "CableRequestRequest struct for CableRequestRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "CableRequestRequestServiceDetails": { + "type_name": "CableRequestRequestServiceDetails", + "description": "CableRequestRequestServiceDetails Please fill out the Media Type, Connector Type and Length (Specify in cm or ft) for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. You may mix jumper types but if you require more than 10 cables, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If 'Quantity' is 1, then below 'Media Type', 'Connector Type' and 'Length (feet/cm)' objects are mandatory.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ConnectorType": { + "name": "ConnectorType", + "description": "", + "json_tag": "connectorType" + }, + "Length": { + "name": "Length", + "description": "Length (feet/cm).", + "json_tag": "length" + }, + "MediaType": { + "name": "MediaType", + "description": "", + "json_tag": "mediaType" + }, + "Quantity": { + "name": "Quantity", + "description": "", + "json_tag": "quantity" + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", + "json_tag": "scopeOfWork" + } + } + }, + "Cage": { + "type_name": "Cage", + "description": "Cage struct for Cage", + "fields": { + "Accounts": { + "name": "Accounts", + "description": "List of Accounts", + "json_tag": "accounts" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cage": { + "name": "Cage", + "description": "Cage or Suite", + "json_tag": "cage" + }, + "CageTypes": { + "name": "CageTypes", + "description": "Cage Types", + "json_tag": "cageTypes" + } + } + }, + "CageCleanupRequest": { + "type_name": "CageCleanupRequest", + "description": "CageCleanupRequest struct for CageCleanupRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "CageCleanupRequestServiceDetails": { + "type_name": "CageCleanupRequestServiceDetails", + "description": "CageCleanupRequestServiceDetails Cage Cleanup", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DampMoistMopRequired": { + "name": "DampMoistMopRequired", + "description": "Is Damp Moist Mop Requested?", + "json_tag": "dampMoistMopRequired" + }, + "PermissionToDiscardBoxes": { + "name": "PermissionToDiscardBoxes", + "description": "Permission To Discard Boxes?", + "json_tag": "permissionToDiscardBoxes" + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", + "json_tag": "scopeOfWork" + } + } + }, + "CageEscortRequest": { + "type_name": "CageEscortRequest", + "description": "CageEscortRequest struct for CageEscortRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "CageEscortRequestServiceDetails": { + "type_name": "CageEscortRequestServiceDetails", + "description": "CageEscortRequestServiceDetails Escort to Open Cage/Open Cabinet", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DurationVisit": { + "name": "DurationVisit", + "description": "", + "json_tag": "durationVisit" + }, + "OpenCabinetForVisitor": { + "name": "OpenCabinetForVisitor", + "description": "Open the Cabinet for the Visitor?", + "json_tag": "openCabinetForVisitor" + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", + "json_tag": "scopeOfWork" + }, + "SupervisionReqForVisitor": { + "name": "SupervisionReqForVisitor", + "description": "Supervision Required For the Visitor?", + "json_tag": "supervisionReqForVisitor" + }, + "WorkVisitOrderNumber": { + "name": "WorkVisitOrderNumber", + "description": "Work Visit Order Number", + "json_tag": "\\\"workVisitOrderNumber\\\" validate:\\\"regexp=^[ A-Za-z0-9~!|\\\\\\\\[\\\\\\\\]@#$%^\u0026*()_+:\\\\\\\"\u003c\u003e?\\\\/." + } + } + }, + "Configuration": { + "type_name": "Configuration", + "description": "Configuration stores the configuration of the API client", + "fields": { + "Debug": { + "name": "Debug", + "description": "", + "json_tag": "debug" + }, + "DefaultHeader": { + "name": "DefaultHeader", + "description": "", + "json_tag": "defaultHeader" + }, + "HTTPClient": { + "name": "HTTPClient", + "description": "" + }, + "Host": { + "name": "Host", + "description": "", + "json_tag": "host" + }, + "OperationServers": { + "name": "OperationServers", + "description": "" + }, + "Scheme": { + "name": "Scheme", + "description": "", + "json_tag": "scheme" + }, + "Servers": { + "name": "Servers", + "description": "" + }, + "UserAgent": { + "name": "UserAgent", + "description": "", + "json_tag": "userAgent" + } + } + }, + "ContactInfo": { + "type_name": "ContactInfo", + "description": "ContactInfo Use this model to build contact object. Ordering and notification contacts are are always equinix registered contacts and we only expect username and rest of the details will be looked up. It is important to know that when username is provided all other attributes apart from contactType will be ignored", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ContactType": { + "name": "ContactType", + "description": "", + "json_tag": "contactType" + }, + "Email": { + "name": "Email", + "description": "Valid email address of the contact", + "json_tag": "email" + }, + "MobilePhone": { + "name": "MobilePhone", + "description": "Mobile Phone of the contact", + "json_tag": "mobilePhone" + }, + "MobilePhoneCountryCode": { + "name": "MobilePhoneCountryCode", + "description": "Country Code of Mobile Phone of the contact", + "json_tag": "mobilePhoneCountryCode" + }, + "MobilePhonePrefToCall": { + "name": "MobilePhonePrefToCall", + "description": "", + "json_tag": "mobilePhonePrefToCall" + }, + "MobilePhoneTimeZone": { + "name": "MobilePhoneTimeZone", + "description": "Mobile Phone TimeZone", + "json_tag": "mobilePhoneTimeZone" + }, + "Name": { + "name": "Name", + "description": "Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'", + "json_tag": "name" + }, + "UserName": { + "name": "UserName", + "description": "User Name", + "json_tag": "userName" + }, + "WorkPhone": { + "name": "WorkPhone", + "description": "Primary Phone of the contact", + "json_tag": "workPhone" + }, + "WorkPhoneCountryCode": { + "name": "WorkPhoneCountryCode", + "description": "Country Code of Primary Phone of the contact", + "json_tag": "workPhoneCountryCode" + }, + "WorkPhonePrefToCall": { + "name": "WorkPhonePrefToCall", + "description": "", + "json_tag": "workPhonePrefToCall" + }, + "WorkPhoneTimeZone": { + "name": "WorkPhoneTimeZone", + "description": "Work Phone TimeZone", + "json_tag": "workPhoneTimeZone" + } + } + }, + "CrossConnectInstall": { + "type_name": "CrossConnectInstall", + "description": "CrossConnectInstall struct for CrossConnectInstall", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeviceCabinet": { + "name": "DeviceCabinet", + "description": "Cross Connect Cabinet", + "json_tag": "deviceCabinet" + }, + "DeviceConnectorType": { + "name": "DeviceConnectorType", + "description": "Cross Connect Device Connector Type", + "json_tag": "deviceConnectorType" + }, + "DeviceDetails": { + "name": "DeviceDetails", + "description": "Cross Connect Device Details", + "json_tag": "deviceDetails" + }, + "DevicePort": { + "name": "DevicePort", + "description": "Cross Connect Device Port", + "json_tag": "devicePort" + }, + "LightLinkVerification": { + "name": "LightLinkVerification", + "description": "Cross Connect Light Link Verification (Optional). Select this option if you would like a light reading provided and tx/rx verification after the cross connect is completed. In order to verify the correct transmit/receive alignment, please ensure your Z-Side Cross Connect Partner has their end fully extended to their equipment and their port is enabled. A separate billable activity will be created.", + "json_tag": "lightLinkVerification" + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Scope of work", + "json_tag": "scopeOfWork" + }, + "SerialNumber": { + "name": "SerialNumber", + "description": "Cross Connect serialNumber", + "json_tag": "serialNumber" + } + } + }, + "CrossConnectRemoval": { + "type_name": "CrossConnectRemoval", + "description": "CrossConnectRemoval struct for CrossConnectRemoval", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeviceCabinet": { + "name": "DeviceCabinet", + "description": "Cross Connect Cabinet", + "json_tag": "deviceCabinet" + }, + "DeviceConnectorType": { + "name": "DeviceConnectorType", + "description": "Cross Connect Device Connector Type", + "json_tag": "deviceConnectorType" + }, + "DeviceDetails": { + "name": "DeviceDetails", + "description": "Cross Connect Device Details", + "json_tag": "deviceDetails" + }, + "DevicePort": { + "name": "DevicePort", + "description": "Cross Connect Device Port", + "json_tag": "devicePort" + }, + "RemovePatchCableWithLiveTraffic": { + "name": "RemovePatchCableWithLiveTraffic", + "description": "Proceed with the de-install if live traffic is detected (Optional). By selecting this option, I agree to the terms of removal with live traffic. Please be advised that Equinix will complete the requested removal based on your instruction and will not be responsible for any service outages resulting from this removal.", + "json_tag": "removePatchCableWithLiveTraffic" + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Scope of work", + "json_tag": "scopeOfWork" + }, + "SerialNumber": { + "name": "SerialNumber", + "description": "Cross Connect serialNumber", + "json_tag": "serialNumber" + } + } + }, + "Device": { + "type_name": "Device", + "description": "Device struct for Device", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Name": { + "name": "Name", + "description": "Device name", + "json_tag": "name" + }, + "Port": { + "name": "Port", + "description": "Device port", + "json_tag": "port" + }, + "Slot": { + "name": "Slot", + "description": "Device slot", + "json_tag": "slot" + } + } + }, + "EquipmentInstallRequest": { + "type_name": "EquipmentInstallRequest", + "description": "EquipmentInstallRequest struct for EquipmentInstallRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "EquipmentInstallRequestServiceDetails": { + "type_name": "EquipmentInstallRequestServiceDetails", + "description": "EquipmentInstallRequestServiceDetails struct for EquipmentInstallRequestServiceDetails", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "DeviceLocation": { + "name": "DeviceLocation", + "description": "Device Location", + "json_tag": "deviceLocation" + }, + "ElevationDrawingAttached": { + "name": "ElevationDrawingAttached", + "description": "Elevation drawing attached?", + "json_tag": "elevationDrawingAttached" + }, + "InstallationPoint": { + "name": "InstallationPoint", + "description": "Installation Point", + "json_tag": "installationPoint" + }, + "InstalledEquipmentPhotoRequired": { + "name": "InstalledEquipmentPhotoRequired", + "description": "Installed Equipment Photo Required?", + "json_tag": "installedEquipmentPhotoRequired" + }, + "MountHardwareIncluded": { + "name": "MountHardwareIncluded", + "description": "Mount hardware included?", + "json_tag": "mountHardwareIncluded" + }, + "NeedSupportFromASubmarineCableStationEngineer": { + "name": "NeedSupportFromASubmarineCableStationEngineer", + "description": "This flag is only applicable to Submarine Cable IBXs", + "json_tag": "needSupportFromASubmarineCableStationEngineer" + }, + "PatchDevices": { + "name": "PatchDevices", + "description": "Patch Devices?", + "json_tag": "patchDevices" + }, + "PatchingInfo": { + "name": "PatchingInfo", + "description": "Patching info", + "json_tag": "patchingInfo" + }, + "PowerItOn": { + "name": "PowerItOn", + "description": "Power it on?", + "json_tag": "powerItOn" + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", + "json_tag": "scopeOfWork" + } + } + }, + "GenericError": { + "type_name": "GenericError", + "description": "GenericError struct for GenericError", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Errors": { + "name": "Errors", + "description": "", + "json_tag": "errors" + }, + "TicketId": { + "name": "TicketId", + "description": "", + "json_tag": "ticketId" + } + } + }, + "GenericOpenAPIError": { + "type_name": "GenericOpenAPIError", + "description": "GenericOpenAPIError Provides access to the body, error and model on returned errors.", + "fields": { + "body": { + "name": "body", + "description": "" + }, + "error": { + "name": "error", + "description": "" + }, + "model": { + "name": "model", + "description": "" + } + } + }, + "GetLocation200Response": { + "type_name": "GetLocation200Response", + "description": "GetLocation200Response struct for GetLocation200Response", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Locations": { + "name": "Locations", + "description": "", + "json_tag": "locations" + } + } + }, + "IbxLocation": { + "type_name": "IbxLocation", + "description": "IbxLocation IBX, Cage, Accounts and Cabinet information", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cages": { + "name": "Cages", + "description": "", + "json_tag": "cages" + }, + "Ibx": { + "name": "Ibx", + "description": "", + "json_tag": "ibx" + } + } + }, + "IbxLocationCagesInner": { + "type_name": "IbxLocationCagesInner", + "description": "IbxLocationCagesInner struct for IbxLocationCagesInner", + "fields": { + "AccountNumber": { + "name": "AccountNumber", + "description": "", + "json_tag": "accountNumber" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cabinets": { + "name": "Cabinets", + "description": "", + "json_tag": "cabinets" + }, + "Cage": { + "name": "Cage", + "description": "", + "json_tag": "cage" + } + } + }, + "LocatePackageRequest": { + "type_name": "LocatePackageRequest", + "description": "LocatePackageRequest struct for LocatePackageRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "LocatePackageRequestServiceDetails": { + "type_name": "LocatePackageRequestServiceDetails", + "description": "LocatePackageRequestServiceDetails Shipment Unpacking", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "PackageDescription": { + "name": "PackageDescription", + "description": "Package Description", + "json_tag": "\\\"packageDescription\\\" validate:\\\"regexp=^[ A-Za-z0-9~!|\\\\\\\\[\\\\\\\\]@#$%^\u0026*()_+:\\\\\\\"\u003c\u003e?\\\\/." + }, + "PossibleLocation": { + "name": "PossibleLocation", + "description": "Possible Location", + "json_tag": "\\\"possibleLocation\\\" validate:\\\"regexp=^[ A-Za-z0-9~!|\\\\\\\\[\\\\\\\\]@#$%^\u0026*()_+:\\\\\\\"\u003c\u003e?\\\\/." + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", + "json_tag": "scopeOfWork" + }, + "ShipmentOrderNumber": { + "name": "ShipmentOrderNumber", + "description": "Inbound Shipment Order Number", + "json_tag": "\\\"shipmentOrderNumber\\\" validate:\\\"regexp=^[ A-Za-z0-9~!|\\\\\\\\[\\\\\\\\]@#$%^\u0026*()_+:\\\\\\\"\u003c\u003e?\\\\/." + }, + "TrackingNumber": { + "name": "TrackingNumber", + "description": "Tracking Number", + "json_tag": "\\\"trackingNumber\\\" validate:\\\"regexp=^[ A-Za-z0-9~!|\\\\\\\\[\\\\\\\\]@#$%^\u0026*()_+:\\\\\\\"\u003c\u003e?\\\\/." + } + } + }, + "Location": { + "type_name": "Location", + "description": "Location struct for Location", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Cages": { + "name": "Cages", + "description": "List of cage", + "json_tag": "cages" + }, + "Ibx": { + "name": "Ibx", + "description": "Ibx Name", + "json_tag": "ibx" + } + } + }, + "MoveJumperCableRequest": { + "type_name": "MoveJumperCableRequest", + "description": "MoveJumperCableRequest struct for MoveJumperCableRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "MoveJumperCableRequestServiceDetails": { + "type_name": "MoveJumperCableRequestServiceDetails", + "description": "MoveJumperCableRequestServiceDetails Move Jumper Cable Service Details Object. Please fill out the Cable ID, Current Device (Name, Slot, Port) and New Device (Name, Slot, Port) details for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. You may mix jumper types but if you require more than 12 jumpers ran, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If 'Quantity' is 1, then below 'currentDeviceDetails' and 'newDeviceDetails' objects are mandatory.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CableId": { + "name": "CableId", + "description": "Enter Cable ID or ‘None’ if not applicable. This field is mandatory if 'Quantity' is 1.", + "json_tag": "cableId" + }, + "CurrentDeviceDetails": { + "name": "CurrentDeviceDetails", + "description": "", + "json_tag": "currentDeviceDetails" + }, + "NewDeviceDetails": { + "name": "NewDeviceDetails", + "description": "", + "json_tag": "newDeviceDetails" + }, + "Quantity": { + "name": "Quantity", + "description": "", + "json_tag": "quantity" + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", + "json_tag": "scopeOfWork" + } + } + }, + "NullableAccount": { + "type_name": "NullableAccount", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableAttachment": { + "type_name": "NullableAttachment", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableBool": { + "type_name": "NullableBool", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCabinets": { + "type_name": "NullableCabinets", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCableRequestRequest": { + "type_name": "NullableCableRequestRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCableRequestRequestServiceDetails": { + "type_name": "NullableCableRequestRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCableRequestRequestServiceDetailsConnectorType": { + "type_name": "NullableCableRequestRequestServiceDetailsConnectorType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCableRequestRequestServiceDetailsMediaType": { + "type_name": "NullableCableRequestRequestServiceDetailsMediaType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCableRequestRequestServiceDetailsQuantity": { + "type_name": "NullableCableRequestRequestServiceDetailsQuantity", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCage": { + "type_name": "NullableCage", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCageCleanupRequest": { + "type_name": "NullableCageCleanupRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCageCleanupRequestServiceDetails": { + "type_name": "NullableCageCleanupRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCageEscortRequest": { + "type_name": "NullableCageEscortRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCageEscortRequestServiceDetails": { + "type_name": "NullableCageEscortRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCageEscortRequestServiceDetailsDurationVisit": { + "type_name": "NullableCageEscortRequestServiceDetailsDurationVisit", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactInfo": { + "type_name": "NullableContactInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactInfoContactType": { + "type_name": "NullableContactInfoContactType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableContactInfoWorkPhonePrefToCall": { + "type_name": "NullableContactInfoWorkPhonePrefToCall", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCrossConnectInstall": { + "type_name": "NullableCrossConnectInstall", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableCrossConnectRemoval": { + "type_name": "NullableCrossConnectRemoval", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableDevice": { + "type_name": "NullableDevice", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableEquipmentInstallRequest": { + "type_name": "NullableEquipmentInstallRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableEquipmentInstallRequestServiceDetails": { + "type_name": "NullableEquipmentInstallRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat32": { + "type_name": "NullableFloat32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat64": { + "type_name": "NullableFloat64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGenericError": { + "type_name": "NullableGenericError", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableGetLocation200Response": { + "type_name": "NullableGetLocation200Response", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIbxLocation": { + "type_name": "NullableIbxLocation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableIbxLocationCagesInner": { + "type_name": "NullableIbxLocationCagesInner", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt": { + "type_name": "NullableInt", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt32": { + "type_name": "NullableInt32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt64": { + "type_name": "NullableInt64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLocatePackageRequest": { + "type_name": "NullableLocatePackageRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLocatePackageRequestServiceDetails": { + "type_name": "NullableLocatePackageRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableLocation": { + "type_name": "NullableLocation", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMoveJumperCableRequest": { + "type_name": "NullableMoveJumperCableRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMoveJumperCableRequestServiceDetails": { + "type_name": "NullableMoveJumperCableRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableMoveJumperCableRequestServiceDetailsQuantity": { + "type_name": "NullableMoveJumperCableRequestServiceDetailsQuantity", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOtherRequest": { + "type_name": "NullableOtherRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableOtherRequestServiceDetails": { + "type_name": "NullableOtherRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePatchCableInstallRequest": { + "type_name": "NullablePatchCableInstallRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePatchCableInstallRequestServiceDetails": { + "type_name": "NullablePatchCableInstallRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePatchCableRemovalRequest": { + "type_name": "NullablePatchCableRemovalRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePatchCableRemovalRequestServiceDetails": { + "type_name": "NullablePatchCableRemovalRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePicturesDocumentRequest": { + "type_name": "NullablePicturesDocumentRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePicturesDocumentRequestServiceDetails": { + "type_name": "NullablePicturesDocumentRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePicturesDocumentRequestServiceDetailsCameraProvidedBy": { + "type_name": "NullablePicturesDocumentRequestServiceDetailsCameraProvidedBy", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePurchaseOrder": { + "type_name": "NullablePurchaseOrder", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullablePurchaseOrderPurchaseOrderType": { + "type_name": "NullablePurchaseOrderPurchaseOrderType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRunJumperCableRequest": { + "type_name": "NullableRunJumperCableRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRunJumperCableRequestServiceDetails": { + "type_name": "NullableRunJumperCableRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRunJumperCableRequestServiceDetailsConnector": { + "type_name": "NullableRunJumperCableRequestServiceDetailsConnector", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRunJumperCableRequestServiceDetailsJumperType": { + "type_name": "NullableRunJumperCableRequestServiceDetailsJumperType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableRunJumperCableRequestServiceDetailsMediaType": { + "type_name": "NullableRunJumperCableRequestServiceDetailsMediaType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableScheduleInfo": { + "type_name": "NullableScheduleInfo", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableScheduleInfoScheduleType": { + "type_name": "NullableScheduleInfoScheduleType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableShipmentUnpackRequest": { + "type_name": "NullableShipmentUnpackRequest", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableShipmentUnpackRequestServiceDetails": { + "type_name": "NullableShipmentUnpackRequestServiceDetails", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSmartHandTypes200Response": { + "type_name": "NullableSmartHandTypes200Response", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSmarthandResponse": { + "type_name": "NullableSmarthandResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableSmarthandType": { + "type_name": "NullableSmarthandType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableString": { + "type_name": "NullableString", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTime": { + "type_name": "NullableTime", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "OtherRequest": { + "type_name": "OtherRequest", + "description": "OtherRequest struct for OtherRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "OtherRequestServiceDetails": { + "type_name": "OtherRequestServiceDetails", + "description": "OtherRequestServiceDetails Other", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", + "json_tag": "scopeOfWork" + } + } + }, + "PatchCableInstallRequest": { + "type_name": "PatchCableInstallRequest", + "description": "PatchCableInstallRequest struct for PatchCableInstallRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "PatchCableInstallRequestServiceDetails": { + "type_name": "PatchCableInstallRequestServiceDetails", + "description": "PatchCableInstallRequestServiceDetails struct for PatchCableInstallRequestServiceDetails", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CrossConnects": { + "name": "CrossConnects", + "description": "", + "json_tag": "crossConnects" + } + } + }, + "PatchCableRemovalRequest": { + "type_name": "PatchCableRemovalRequest", + "description": "PatchCableRemovalRequest struct for PatchCableRemovalRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "PatchCableRemovalRequestServiceDetails": { + "type_name": "PatchCableRemovalRequestServiceDetails", + "description": "PatchCableRemovalRequestServiceDetails struct for PatchCableRemovalRequestServiceDetails", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CrossConnects": { + "name": "CrossConnects", + "description": "", + "json_tag": "crossConnects" + } + } + }, + "PicturesDocumentRequest": { + "type_name": "PicturesDocumentRequest", + "description": "PicturesDocumentRequest struct for PicturesDocumentRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "PicturesDocumentRequestServiceDetails": { + "type_name": "PicturesDocumentRequestServiceDetails", + "description": "PicturesDocumentRequestServiceDetails struct for PicturesDocumentRequestServiceDetails", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CameraProvidedBy": { + "name": "CameraProvidedBy", + "description": "", + "json_tag": "cameraProvidedBy" + }, + "Description": { + "name": "Description", + "description": "Descrption of the Photo/Document. If documentOnly is false, this field is mandatory.", + "json_tag": "description" + }, + "DocumentOnly": { + "name": "DocumentOnly", + "description": "Do you need documents or pictures? Set true if you need documents.", + "json_tag": "documentOnly" + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", + "json_tag": "scopeOfWork" + }, + "SpecificDateAndTime": { + "name": "SpecificDateAndTime", + "description": "Would you like to request a specific date and time? If true, Scheduling should not be STANDARD. If documentOnly is false, this field is mandatory.", + "json_tag": "specificDateAndTime" + } + } + }, + "PurchaseOrder": { + "type_name": "PurchaseOrder", + "description": "PurchaseOrder Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Number": { + "name": "Number", + "description": "Purchase Order Number", + "json_tag": "number" + }, + "PurchaseOrderType": { + "name": "PurchaseOrderType", + "description": "", + "json_tag": "purchaseOrderType" + } + } + }, + "RunJumperCableRequest": { + "type_name": "RunJumperCableRequest", + "description": "RunJumperCableRequest struct for RunJumperCableRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "RunJumperCableRequestServiceDetails": { + "type_name": "RunJumperCableRequestServiceDetails", + "description": "RunJumperCableRequestServiceDetails Move Jumper Cable Service Details Object. Please fill out the Media Type, Connector Type, Cable ID(optional), 'Should Equinix provide you Tx/Rx light levels, Yes Or No?', Devices to Connect details for Device#1 (Name/Panel, Device Slot, Device Ports) and Device#2(Optional) (Name/Panel, Device Slot, Device Ports) details for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. If any device is being shipped to Equinix, please include the shipment number. You may mix jumper types but if you require more than 12 jumpers ran, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If ‘Quantity’ is 1, then ‘Jumper Type’, Media Type, Connector Type, 'Should Equinix provide you Tx/Rx light levels?' and Device details are mandatory.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CableId": { + "name": "CableId", + "description": "Cable ID", + "json_tag": "cableId" + }, + "Connector": { + "name": "Connector", + "description": "", + "json_tag": "connector" + }, + "DeviceDetails": { + "name": "DeviceDetails", + "description": "", + "json_tag": "deviceDetails" + }, + "JumperType": { + "name": "JumperType", + "description": "", + "json_tag": "jumperType" + }, + "MediaType": { + "name": "MediaType", + "description": "", + "json_tag": "mediaType" + }, + "ProvideTxRxLightLevels": { + "name": "ProvideTxRxLightLevels", + "description": "Provide Tx/Rx Light Levels", + "json_tag": "provideTxRxLightLevels" + }, + "Quantity": { + "name": "Quantity", + "description": "", + "json_tag": "quantity" + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", + "json_tag": "scopeOfWork" + } + } + }, + "ScheduleInfo": { + "type_name": "ScheduleInfo", + "description": "ScheduleInfo Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "RequestedCompletionDate": { + "name": "RequestedCompletionDate", + "description": "Requested Completion Date Time (ISO Date)\u003cbr\u003eCannot Past Date.", + "json_tag": "requestedCompletionDate" + }, + "RequestedStartDate": { + "name": "RequestedStartDate", + "description": "Requested Start Date Time (ISO Date)\u003cbr\u003e Cannot Past Date.", + "json_tag": "requestedStartDate" + }, + "ScheduleType": { + "name": "ScheduleType", + "description": "", + "json_tag": "scheduleType" + } + } + }, + "ServerConfiguration": { + "type_name": "ServerConfiguration", + "description": "ServerConfiguration stores the information about a server", + "fields": { + "Description": { + "name": "Description", + "description": "" + }, + "URL": { + "name": "URL", + "description": "" + }, + "Variables": { + "name": "Variables", + "description": "" + } + } + }, + "ServerVariable": { + "type_name": "ServerVariable", + "description": "ServerVariable stores the information about a server variable", + "fields": { + "DefaultValue": { + "name": "DefaultValue", + "description": "" + }, + "Description": { + "name": "Description", + "description": "" + }, + "EnumValues": { + "name": "EnumValues", + "description": "" + } + } + }, + "ShipmentUnpackRequest": { + "type_name": "ShipmentUnpackRequest", + "description": "ShipmentUnpackRequest struct for ShipmentUnpackRequest", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Attachments": { + "name": "Attachments", + "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", + "json_tag": "attachments" + }, + "Contacts": { + "name": "Contacts", + "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", + "json_tag": "contacts" + }, + "CustomerReferenceNumber": { + "name": "CustomerReferenceNumber", + "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", + "json_tag": "customerReferenceNumber" + }, + "IbxLocation": { + "name": "IbxLocation", + "description": "", + "json_tag": "ibxLocation" + }, + "PurchaseOrder": { + "name": "PurchaseOrder", + "description": "", + "json_tag": "purchaseOrder" + }, + "Schedule": { + "name": "Schedule", + "description": "", + "json_tag": "schedule" + }, + "ServiceDetails": { + "name": "ServiceDetails", + "description": "", + "json_tag": "serviceDetails" + } + } + }, + "ShipmentUnpackRequestServiceDetails": { + "type_name": "ShipmentUnpackRequestServiceDetails", + "description": "ShipmentUnpackRequestServiceDetails Shipment Unpacking", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "CopyOfPackingSlipNeeded": { + "name": "CopyOfPackingSlipNeeded", + "description": "Copy of Packaging Slip Needed?", + "json_tag": "copyOfPackingSlipNeeded" + }, + "DiscardShipmentMaterial": { + "name": "DiscardShipmentMaterial", + "description": "Discard Shipment Material?", + "json_tag": "discardShipmentMaterial" + }, + "InboundShipmentOrderNumber": { + "name": "InboundShipmentOrderNumber", + "description": "Inbound Shipment Order Number", + "json_tag": "\\\"inboundShipmentOrderNumber\\\" validate:\\\"regexp=^[ A-Za-z0-9~!|\\\\\\\\[\\\\\\\\]@#$%^\u0026*()_+:\\\\\\\"\u003c\u003e?\\\\/." + }, + "ScopeOfWork": { + "name": "ScopeOfWork", + "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", + "json_tag": "scopeOfWork" + } + } + }, + "SmartHandTypes200Response": { + "type_name": "SmartHandTypes200Response", + "description": "SmartHandTypes200Response struct for SmartHandTypes200Response", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Smarthands": { + "name": "Smarthands", + "description": "", + "json_tag": "smarthands" + } + } + }, + "SmarthandResponse": { + "type_name": "SmarthandResponse", + "description": "SmarthandResponse Order has been submitted successfully", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "OrderNumber": { + "name": "OrderNumber", + "description": "Order Number", + "json_tag": "orderNumber" + } + } + }, + "SmarthandType": { + "type_name": "SmarthandType", + "description": "SmarthandType struct for SmarthandType", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Type": { + "name": "Type", + "description": "Smarthand Type", + "json_tag": "type" + }, + "TypeDescription": { + "name": "TypeDescription", + "description": "Description of Smarthand Type", + "json_tag": "typeDescription" + } + } + }, + "formFile": { + "type_name": "formFile", + "fields": { + "fileBytes": { + "name": "fileBytes", + "description": "" + }, + "fileName": { + "name": "fileName", + "description": "" + }, + "formFileName": { + "name": "formFileName", + "description": "" + } + } + }, + "service": { + "type_name": "service", + "fields": { + "client": { + "name": "client", + "description": "" + } + } + } + } +} \ No newline at end of file diff --git a/cmd/descriptions/stsv1alpha.json b/cmd/descriptions/stsv1alpha.json new file mode 100644 index 0000000..09c91ab --- /dev/null +++ b/cmd/descriptions/stsv1alpha.json @@ -0,0 +1,520 @@ +{ + "services": { + "use": { + "service_name": "use", + "service_description": "", + "methods": { + "UseTokenPost": { + "short_description": "Method for UseTokenPost", + "long_description": "An OAuth 2.0 token endpoint supporting RFC 8693 token exchange, used to exchange an OIDC ID token issued by a trusted OIDC provider to a trusted client for an access token that can be used access other Equinix product APIs.", + "parameters": [ + { + "name": "ctx", + "description": "for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background()." + } + ] + }, + "UseTokenPostExecute": { + "short_description": "Execute executes the request", + "long_description": "" + } + }, + "types": { + "ApiUseTokenPostRequest": { + "type_name": "ApiUseTokenPostRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "grantType": { + "name": "grantType", + "description": "" + }, + "scope": { + "name": "scope", + "description": "" + }, + "subjectToken": { + "name": "subjectToken", + "description": "" + }, + "subjectTokenType": { + "name": "subjectTokenType", + "description": "" + } + } + } + } + } + }, + "types": { + "APIClient": { + "type_name": "APIClient", + "description": "APIClient manages communication with the Equinix Security Token Service API v1.0.0-alpha\nIn most cases there should be only one, shared, APIClient.", + "fields": { + "UseApi": { + "name": "UseApi", + "description": "" + }, + "cfg": { + "name": "cfg", + "description": "" + }, + "common": { + "name": "common", + "description": "Reuse a single struct instead of allocating one for each service on the heap." + } + } + }, + "APIKey": { + "type_name": "APIKey", + "description": "APIKey provides API key based authentication to a request passed via context using ContextAPIKey", + "fields": { + "Key": { + "name": "Key", + "description": "" + }, + "Prefix": { + "name": "Prefix", + "description": "" + } + } + }, + "APIResponse": { + "type_name": "APIResponse", + "description": "APIResponse stores the API response returned by the server.", + "fields": { + "Message": { + "name": "Message", + "description": "", + "json_tag": "message" + }, + "Method": { + "name": "Method", + "description": "Method is the HTTP method used for the request. This value is always\navailable, even if the embedded *http.Response is nil.", + "json_tag": "method" + }, + "Operation": { + "name": "Operation", + "description": "Operation is the name of the OpenAPI operation.", + "json_tag": "operation" + }, + "Payload": { + "name": "Payload", + "description": "Payload holds the contents of the response body (which may be nil or empty).\nThis is provided here as the raw response.Body() reader will have already\nbeen drained.", + "json_tag": "-" + }, + "RequestURL": { + "name": "RequestURL", + "description": "RequestURL is the request URL. This value is always available, even if the\nembedded *http.Response is nil.", + "json_tag": "url" + } + } + }, + "ApiUseTokenPostRequest": { + "type_name": "ApiUseTokenPostRequest", + "fields": { + "ApiService": { + "name": "ApiService", + "description": "" + }, + "ctx": { + "name": "ctx", + "description": "" + }, + "grantType": { + "name": "grantType", + "description": "" + }, + "scope": { + "name": "scope", + "description": "" + }, + "subjectToken": { + "name": "subjectToken", + "description": "" + }, + "subjectTokenType": { + "name": "subjectTokenType", + "description": "" + } + } + }, + "BasicAuth": { + "type_name": "BasicAuth", + "description": "BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth", + "fields": { + "Password": { + "name": "Password", + "description": "", + "json_tag": "password" + }, + "UserName": { + "name": "UserName", + "description": "", + "json_tag": "userName" + } + } + }, + "Configuration": { + "type_name": "Configuration", + "description": "Configuration stores the configuration of the API client", + "fields": { + "Debug": { + "name": "Debug", + "description": "", + "json_tag": "debug" + }, + "DefaultHeader": { + "name": "DefaultHeader", + "description": "", + "json_tag": "defaultHeader" + }, + "HTTPClient": { + "name": "HTTPClient", + "description": "" + }, + "Host": { + "name": "Host", + "description": "", + "json_tag": "host" + }, + "OperationServers": { + "name": "OperationServers", + "description": "" + }, + "Scheme": { + "name": "Scheme", + "description": "", + "json_tag": "scheme" + }, + "Servers": { + "name": "Servers", + "description": "" + }, + "UserAgent": { + "name": "UserAgent", + "description": "", + "json_tag": "userAgent" + } + } + }, + "ErrorResponse": { + "type_name": "ErrorResponse", + "description": "ErrorResponse struct for ErrorResponse", + "fields": { + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "Error": { + "name": "Error", + "description": "A short, machine-readable error code.", + "json_tag": "error" + }, + "ErrorDescription": { + "name": "ErrorDescription", + "description": "A human-readable description of the error.", + "json_tag": "error_description" + } + } + }, + "GenericOpenAPIError": { + "type_name": "GenericOpenAPIError", + "description": "GenericOpenAPIError Provides access to the body, error and model on returned errors.", + "fields": { + "body": { + "name": "body", + "description": "" + }, + "error": { + "name": "error", + "description": "" + }, + "model": { + "name": "model", + "description": "" + } + } + }, + "NullableBool": { + "type_name": "NullableBool", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableErrorResponse": { + "type_name": "NullableErrorResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat32": { + "type_name": "NullableFloat32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableFloat64": { + "type_name": "NullableFloat64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt": { + "type_name": "NullableInt", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt32": { + "type_name": "NullableInt32", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableInt64": { + "type_name": "NullableInt64", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableString": { + "type_name": "NullableString", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTime": { + "type_name": "NullableTime", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTokenExchangeResponse": { + "type_name": "NullableTokenExchangeResponse", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTokenExchangeResponseIssuedTokenType": { + "type_name": "NullableTokenExchangeResponseIssuedTokenType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableTokenExchangeResponseTokenType": { + "type_name": "NullableTokenExchangeResponseTokenType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUseTokenPostRequestGrantType": { + "type_name": "NullableUseTokenPostRequestGrantType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "NullableUseTokenPostRequestSubjectTokenType": { + "type_name": "NullableUseTokenPostRequestSubjectTokenType", + "fields": { + "isSet": { + "name": "isSet", + "description": "" + }, + "value": { + "name": "value", + "description": "" + } + } + }, + "ServerConfiguration": { + "type_name": "ServerConfiguration", + "description": "ServerConfiguration stores the information about a server", + "fields": { + "Description": { + "name": "Description", + "description": "" + }, + "URL": { + "name": "URL", + "description": "" + }, + "Variables": { + "name": "Variables", + "description": "" + } + } + }, + "ServerVariable": { + "type_name": "ServerVariable", + "description": "ServerVariable stores the information about a server variable", + "fields": { + "DefaultValue": { + "name": "DefaultValue", + "description": "" + }, + "Description": { + "name": "Description", + "description": "" + }, + "EnumValues": { + "name": "EnumValues", + "description": "" + } + } + }, + "TokenExchangeResponse": { + "type_name": "TokenExchangeResponse", + "description": "TokenExchangeResponse struct for TokenExchangeResponse", + "fields": { + "AccessToken": { + "name": "AccessToken", + "description": "", + "json_tag": "access_token" + }, + "AdditionalProperties": { + "name": "AdditionalProperties", + "description": "" + }, + "ExpiresIn": { + "name": "ExpiresIn", + "description": "", + "json_tag": "expires_in" + }, + "IssuedTokenType": { + "name": "IssuedTokenType", + "description": "", + "json_tag": "issued_token_type" + }, + "TokenType": { + "name": "TokenType", + "description": "", + "json_tag": "token_type" + } + } + }, + "formFile": { + "type_name": "formFile", + "fields": { + "fileBytes": { + "name": "fileBytes", + "description": "" + }, + "fileName": { + "name": "fileName", + "description": "" + }, + "formFileName": { + "name": "formFileName", + "description": "" + } + } + }, + "service": { + "type_name": "service", + "fields": { + "client": { + "name": "client", + "description": "" + } + } + } + } +} \ No newline at end of file diff --git a/cmd/eiav2.go b/cmd/eiav2.go new file mode 100644 index 0000000..560dc06 --- /dev/null +++ b/cmd/eiav2.go @@ -0,0 +1,80 @@ +package cmd + +import ( + _ "embed" + "fmt" + "os" + + "github.com/equinix/cli/internal/eiav2" + "github.com/equinix/cli/internal/register" + "github.com/spf13/cobra" +) + +// TODO: Put service subcommands in separate packages to +// avoid variable naming collisions +var eiav2Debug bool + +//go:embed descriptions/eiav2.json +var eiav2Descriptions []byte + +// eiav2Cmd represents the eiav2 command +var eiav2Cmd = &cobra.Command{ + Use: "eiav2", + Short: "Manage Equinix eiav2 resources", + Long: `Commands for managing Equinix eiav2 resources. + +The eiav2 commands are dynamically generated based on the eiav2 API client, +providing access to all available API services.`, + PersistentPreRun: func(cmd *cobra.Command, _ []string) { + // Inject the client factory into the command context so that + // it can be retrieved at execution time + executionClientFactory := func() (register.APIClientInterface, error) { + eiav2.SetDebug(eiav2Debug) + return eiav2.NewClient() + } + cmd.SetContext(register.ContextWithClientFactory(cmd.Context(), executionClientFactory)) + }, +} + +func init() { + rootCmd.AddCommand(eiav2Cmd) + + // Add common debug flag that will be inherited by all subcommands for eiav2 + eiav2Cmd.PersistentFlags().BoolVar(&eiav2Debug, "debug", false, "Enable debug logging for HTTP requests") + + // Add common format flag that will be inherited by all subcommands for eiav2 + eiav2Cmd.PersistentFlags().StringP("format", "f", "json", "Format to use for output (json or yaml)") + + // Load SDK descriptions for better command documentation + if err := register.LoadDescriptions(eiav2Descriptions); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Could not load eiav2 descriptions: %v\n", err) + } + + // Register commands at init time for help/discovery + // We use a discovery client that doesn't require credentials for structure introspection + // Actual API calls will validate credentials at runtime + client, err := eiav2.NewClientForDiscovery() + if err != nil { + // If we can't even create a discovery client, log a warning but continue + // Commands won't be available but the CLI won't crash + fmt.Fprintf(os.Stderr, "Warning: Could not register eiav2 commands: %v\n", err) + return + } + + // Register all service commands dynamically + err = register.ServiceCommands(eiav2Cmd, client, "eiav2") + if err != nil { + fmt.Fprintf(os.Stderr, "Warning: Failed to register eiav2 commands: %v\n", err) + } + + // Uncomment and customize aliases as needed for convenience + // Example: Add shorter aliases for commonly used commands + // eiav2Cmd.Aliases = []string{"eia"} + // + // Or add aliases to specific subcommands after registration: + // if connectionsCmd, _, err := eiav2Cmd.Find([]string{"connections"}); err == nil { + // if createCmd, _, err := connectionsCmd.Find([]string{"create-connection"}); err == nil { + // createCmd.Aliases = []string{"create"} + // } + // } +} diff --git a/cmd/fabricv4.go b/cmd/fabricv4.go new file mode 100644 index 0000000..882ca9a --- /dev/null +++ b/cmd/fabricv4.go @@ -0,0 +1,80 @@ +package cmd + +import ( + _ "embed" + "fmt" + "os" + + "github.com/equinix/cli/internal/fabricv4" + "github.com/equinix/cli/internal/register" + "github.com/spf13/cobra" +) + +// TODO: Put service subcommands in separate packages to +// avoid variable naming collisions +var fabricv4Debug bool + +//go:embed descriptions/fabricv4.json +var fabricv4Descriptions []byte + +// fabricv4Cmd represents the fabricv4 command +var fabricv4Cmd = &cobra.Command{ + Use: "fabricv4", + Short: "Manage Equinix fauricv4 resources", + Long: `Commands for managing Equinix fauricv4 resources. + +The fabricv4 commands are dynamically generated based on the fauricv4 API client, +providing access to all available API services.`, + PersistentPreRun: func(cmd *cobra.Command, _ []string) { + // Inject the client factory into the command context so that + // it can be retrieved at execution time + executionClientFactory := func() (register.APIClientInterface, error) { + fabricv4.SetDebug(fabricv4Debug) + return fabricv4.NewClient() + } + cmd.SetContext(register.ContextWithClientFactory(cmd.Context(), executionClientFactory)) + }, +} + +func init() { + rootCmd.AddCommand(fabricv4Cmd) + + // Add common debug flag that will be inherited by all subcommands for fabricv4 + fabricv4Cmd.PersistentFlags().BoolVar(&fabricv4Debug, "debug", false, "Enable debug logging for HTTP requests") + + // Add common format flag that will be inherited by all subcommands for fabricv4 + fabricv4Cmd.PersistentFlags().StringP("format", "f", "json", "Format to use for output (json or yaml)") + + // Load SDK descriptions for better command documentation + if err := register.LoadDescriptions(fabricv4Descriptions); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Could not load fabricv4 descriptions: %v\n", err) + } + + // Register commands at init time for help/discovery + // We use a discovery client that doesn't require credentials for structure introspection + // Actual API calls will validate credentials at runtime + client, err := fabricv4.NewClientForDiscovery() + if err != nil { + // If we can't even create a discovery client, log a warning but continue + // Commands won't be available but the CLI won't crash + fmt.Fprintf(os.Stderr, "Warning: Could not register fabricv4 commands: %v\n", err) + return + } + + // Register all service commands dynamically + err = register.ServiceCommands(fabricv4Cmd, client, "fabricv4") + if err != nil { + fmt.Fprintf(os.Stderr, "Warning: Failed to register fabricv4 commands: %v\n", err) + } + + // Uncomment and customize aliases as needed for convenience + // Example: Add shorter aliases for commonly used commands + // fabricv4Cmd.Aliases = []string{"fabric"} + // + // Or add aliases to specific subcommands after registration: + // if connectionsCmd, _, err := fabricv4Cmd.Find([]string{"connections"}); err == nil { + // if createCmd, _, err := connectionsCmd.Find([]string{"create-connection"}); err == nil { + // createCmd.Aliases = []string{"create"} + // } + // } +} diff --git a/cmd/lookupv2.go b/cmd/lookupv2.go new file mode 100644 index 0000000..8f94f3f --- /dev/null +++ b/cmd/lookupv2.go @@ -0,0 +1,80 @@ +package cmd + +import ( + _ "embed" + "fmt" + "os" + + "github.com/equinix/cli/internal/lookupv2" + "github.com/equinix/cli/internal/register" + "github.com/spf13/cobra" +) + +// TODO: Put service subcommands in separate packages to +// avoid variable naming collisions +var lookupv2Debug bool + +//go:embed descriptions/lookupv2.json +var lookupv2Descriptions []byte + +// lookupv2Cmd represents the lookupv2 command +var lookupv2Cmd = &cobra.Command{ + Use: "lookupv2", + Short: "Manage Equinix lookupv2 resources", + Long: `Commands for managing Equinix lookupv2 resources. + +The lookupv2 commands are dynamically generated based on the lookupv2 API client, +providing access to all available API services.`, + PersistentPreRun: func(cmd *cobra.Command, _ []string) { + // Inject the client factory into the command context so that + // it can be retrieved at execution time + executionClientFactory := func() (register.APIClientInterface, error) { + lookupv2.SetDebug(lookupv2Debug) + return lookupv2.NewClient() + } + cmd.SetContext(register.ContextWithClientFactory(cmd.Context(), executionClientFactory)) + }, +} + +func init() { + rootCmd.AddCommand(lookupv2Cmd) + + // Add common debug flag that will be inherited by all subcommands for lookupv2 + lookupv2Cmd.PersistentFlags().BoolVar(&lookupv2Debug, "debug", false, "Enable debug logging for HTTP requests") + + // Add common format flag that will be inherited by all subcommands for lookupv2 + lookupv2Cmd.PersistentFlags().StringP("format", "f", "json", "Format to use for output (json or yaml)") + + // Load SDK descriptions for better command documentation + if err := register.LoadDescriptions(lookupv2Descriptions); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Could not load lookupv2 descriptions: %v\n", err) + } + + // Register commands at init time for help/discovery + // We use a discovery client that doesn't require credentials for structure introspection + // Actual API calls will validate credentials at runtime + client, err := lookupv2.NewClientForDiscovery() + if err != nil { + // If we can't even create a discovery client, log a warning but continue + // Commands won't be available but the CLI won't crash + fmt.Fprintf(os.Stderr, "Warning: Could not register lookupv2 commands: %v\n", err) + return + } + + // Register all service commands dynamically + err = register.ServiceCommands(lookupv2Cmd, client, "lookupv2") + if err != nil { + fmt.Fprintf(os.Stderr, "Warning: Failed to register lookupv2 commands: %v\n", err) + } + + // Uncomment and customize aliases as needed for convenience + // Example: Add shorter aliases for commonly used commands + // lookupv2Cmd.Aliases = []string{"lookup"} + // + // Or add aliases to specific subcommands after registration: + // if connectionsCmd, _, err := lookupv2Cmd.Find([]string{"connections"}); err == nil { + // if createCmd, _, err := connectionsCmd.Find([]string{"create-connection"}); err == nil { + // createCmd.Aliases = []string{"create"} + // } + // } +} diff --git a/cmd/metalv1.go b/cmd/metalv1.go new file mode 100644 index 0000000..3e2dc30 --- /dev/null +++ b/cmd/metalv1.go @@ -0,0 +1,80 @@ +package cmd + +import ( + _ "embed" + "fmt" + "os" + + "github.com/equinix/cli/internal/metalv1" + "github.com/equinix/cli/internal/register" + "github.com/spf13/cobra" +) + +// TODO: Put service subcommands in separate packages to +// avoid variable naming collisions +var metalv1Debug bool + +//go:embed descriptions/metalv1.json +var metalv1Descriptions []byte + +// metalv1Cmd represents the metalv1 command +var metalv1Cmd = &cobra.Command{ + Use: "metalv1", + Short: "Manage Equinix metalv1 resources", + Long: `Commands for managing Equinix metalv1 resources. + +The metalv1 commands are dynamically generated based on the metalv1 API client, +providing access to all available API services.`, + PersistentPreRun: func(cmd *cobra.Command, _ []string) { + // Inject the client factory into the command context so that + // it can be retrieved at execution time + executionClientFactory := func() (register.APIClientInterface, error) { + metalv1.SetDebug(metalv1Debug) + return metalv1.NewClient() + } + cmd.SetContext(register.ContextWithClientFactory(cmd.Context(), executionClientFactory)) + }, +} + +func init() { + rootCmd.AddCommand(metalv1Cmd) + + // Add common debug flag that will be inherited by all subcommands for metalv1 + metalv1Cmd.PersistentFlags().BoolVar(&metalv1Debug, "debug", false, "Enable debug logging for HTTP requests") + + // Add common format flag that will be inherited by all subcommands for metalv1 + metalv1Cmd.PersistentFlags().StringP("format", "f", "json", "Format to use for output (json or yaml)") + + // Load SDK descriptions for better command documentation + if err := register.LoadDescriptions(metalv1Descriptions); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Could not load metalv1 descriptions: %v\n", err) + } + + // Register commands at init time for help/discovery + // We use a discovery client that doesn't require credentials for structure introspection + // Actual API calls will validate credentials at runtime + client, err := metalv1.NewClientForDiscovery() + if err != nil { + // If we can't even create a discovery client, log a warning but continue + // Commands won't be available but the CLI won't crash + fmt.Fprintf(os.Stderr, "Warning: Could not register metalv1 commands: %v\n", err) + return + } + + // Register all service commands dynamically + err = register.ServiceCommands(metalv1Cmd, client, "metalv1") + if err != nil { + fmt.Fprintf(os.Stderr, "Warning: Failed to register metalv1 commands: %v\n", err) + } + + // Uncomment and customize aliases as needed for convenience + // Example: Add shorter aliases for commonly used commands + // metalv1Cmd.Aliases = []string{"metal"} + // + // Or add aliases to specific subcommands after registration: + // if connectionsCmd, _, err := metalv1Cmd.Find([]string{"connections"}); err == nil { + // if createCmd, _, err := connectionsCmd.Find([]string{"create-connection"}); err == nil { + // createCmd.Aliases = []string{"create"} + // } + // } +} diff --git a/cmd/orderhistoryv1.go b/cmd/orderhistoryv1.go new file mode 100644 index 0000000..0d24cfb --- /dev/null +++ b/cmd/orderhistoryv1.go @@ -0,0 +1,80 @@ +package cmd + +import ( + _ "embed" + "fmt" + "os" + + "github.com/equinix/cli/internal/orderhistoryv1" + "github.com/equinix/cli/internal/register" + "github.com/spf13/cobra" +) + +// TODO: Put service subcommands in separate packages to +// avoid variable naming collisions +var orderhistoryv1Debug bool + +//go:embed descriptions/orderhistoryv1.json +var orderhistoryv1Descriptions []byte + +// orderhistoryv1Cmd represents the orderhistoryv1 command +var orderhistoryv1Cmd = &cobra.Command{ + Use: "orderhistoryv1", + Short: "Manage Equinix orderhistoryv1 resources", + Long: `Commands for managing Equinix orderhistoryv1 resources. + +The orderhistoryv1 commands are dynamically generated based on the orderhistoryv1 API client, +providing access to all available API services.`, + PersistentPreRun: func(cmd *cobra.Command, _ []string) { + // Inject the client factory into the command context so that + // it can be retrieved at execution time + executionClientFactory := func() (register.APIClientInterface, error) { + orderhistoryv1.SetDebug(orderhistoryv1Debug) + return orderhistoryv1.NewClient() + } + cmd.SetContext(register.ContextWithClientFactory(cmd.Context(), executionClientFactory)) + }, +} + +func init() { + rootCmd.AddCommand(orderhistoryv1Cmd) + + // Add common debug flag that will be inherited by all subcommands for orderhistoryv1 + orderhistoryv1Cmd.PersistentFlags().BoolVar(&orderhistoryv1Debug, "debug", false, "Enable debug logging for HTTP requests") + + // Add common format flag that will be inherited by all subcommands for orderhistoryv1 + orderhistoryv1Cmd.PersistentFlags().StringP("format", "f", "json", "Format to use for output (json or yaml)") + + // Load SDK descriptions for better command documentation + if err := register.LoadDescriptions(orderhistoryv1Descriptions); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Could not load orderhistoryv1 descriptions: %v\n", err) + } + + // Register commands at init time for help/discovery + // We use a discovery client that doesn't require credentials for structure introspection + // Actual API calls will validate credentials at runtime + client, err := orderhistoryv1.NewClientForDiscovery() + if err != nil { + // If we can't even create a discovery client, log a warning but continue + // Commands won't be available but the CLI won't crash + fmt.Fprintf(os.Stderr, "Warning: Could not register orderhistoryv1 commands: %v\n", err) + return + } + + // Register all service commands dynamically + err = register.ServiceCommands(orderhistoryv1Cmd, client, "orderhistoryv1") + if err != nil { + fmt.Fprintf(os.Stderr, "Warning: Failed to register orderhistoryv1 commands: %v\n", err) + } + + // Uncomment and customize aliases as needed for convenience + // Example: Add shorter aliases for commonly used commands + // orderhistoryv1Cmd.Aliases = []string{"orderhistory"} + // + // Or add aliases to specific subcommands after registration: + // if connectionsCmd, _, err := orderhistoryv1Cmd.Find([]string{"connections"}); err == nil { + // if createCmd, _, err := connectionsCmd.Find([]string{"create-connection"}); err == nil { + // createCmd.Aliases = []string{"create"} + // } + // } +} diff --git a/cmd/ordersv2.go b/cmd/ordersv2.go new file mode 100644 index 0000000..c1809f7 --- /dev/null +++ b/cmd/ordersv2.go @@ -0,0 +1,80 @@ +package cmd + +import ( + _ "embed" + "fmt" + "os" + + "github.com/equinix/cli/internal/ordersv2" + "github.com/equinix/cli/internal/register" + "github.com/spf13/cobra" +) + +// TODO: Put service subcommands in separate packages to +// avoid variable naming collisions +var ordersv2Debug bool + +//go:embed descriptions/ordersv2.json +var ordersv2Descriptions []byte + +// ordersv2Cmd represents the ordersv2 command +var ordersv2Cmd = &cobra.Command{ + Use: "ordersv2", + Short: "Manage Equinix ordersv2 resources", + Long: `Commands for managing Equinix ordersv2 resources. + +The ordersv2 commands are dynamically generated based on the ordersv2 API client, +providing access to all available API services.`, + PersistentPreRun: func(cmd *cobra.Command, _ []string) { + // Inject the client factory into the command context so that + // it can be retrieved at execution time + executionClientFactory := func() (register.APIClientInterface, error) { + ordersv2.SetDebug(ordersv2Debug) + return ordersv2.NewClient() + } + cmd.SetContext(register.ContextWithClientFactory(cmd.Context(), executionClientFactory)) + }, +} + +func init() { + rootCmd.AddCommand(ordersv2Cmd) + + // Add common debug flag that will be inherited by all subcommands for ordersv2 + ordersv2Cmd.PersistentFlags().BoolVar(&ordersv2Debug, "debug", false, "Enable debug logging for HTTP requests") + + // Add common format flag that will be inherited by all subcommands for ordersv2 + ordersv2Cmd.PersistentFlags().StringP("format", "f", "json", "Format to use for output (json or yaml)") + + // Load SDK descriptions for better command documentation + if err := register.LoadDescriptions(ordersv2Descriptions); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Could not load ordersv2 descriptions: %v\n", err) + } + + // Register commands at init time for help/discovery + // We use a discovery client that doesn't require credentials for structure introspection + // Actual API calls will validate credentials at runtime + client, err := ordersv2.NewClientForDiscovery() + if err != nil { + // If we can't even create a discovery client, log a warning but continue + // Commands won't be available but the CLI won't crash + fmt.Fprintf(os.Stderr, "Warning: Could not register ordersv2 commands: %v\n", err) + return + } + + // Register all service commands dynamically + err = register.ServiceCommands(ordersv2Cmd, client, "ordersv2") + if err != nil { + fmt.Fprintf(os.Stderr, "Warning: Failed to register ordersv2 commands: %v\n", err) + } + + // Uncomment and customize aliases as needed for convenience + // Example: Add shorter aliases for commonly used commands + // ordersv2Cmd.Aliases = []string{"orders"} + // + // Or add aliases to specific subcommands after registration: + // if connectionsCmd, _, err := ordersv2Cmd.Find([]string{"connections"}); err == nil { + // if createCmd, _, err := connectionsCmd.Find([]string{"create-connection"}); err == nil { + // createCmd.Aliases = []string{"create"} + // } + // } +} diff --git a/cmd/securecabinetv1.go b/cmd/securecabinetv1.go new file mode 100644 index 0000000..1861265 --- /dev/null +++ b/cmd/securecabinetv1.go @@ -0,0 +1,80 @@ +package cmd + +import ( + _ "embed" + "fmt" + "os" + + "github.com/equinix/cli/internal/securecabinetv1" + "github.com/equinix/cli/internal/register" + "github.com/spf13/cobra" +) + +// TODO: Put service subcommands in separate packages to +// avoid variable naming collisions +var securecabinetv1Debug bool + +//go:embed descriptions/securecabinetv1.json +var securecabinetv1Descriptions []byte + +// securecabinetv1Cmd represents the securecabinetv1 command +var securecabinetv1Cmd = &cobra.Command{ + Use: "securecabinetv1", + Short: "Manage Equinix securecauinetv1 resources", + Long: `Commands for managing Equinix securecauinetv1 resources. + +The securecabinetv1 commands are dynamically generated based on the securecauinetv1 API client, +providing access to all available API services.`, + PersistentPreRun: func(cmd *cobra.Command, _ []string) { + // Inject the client factory into the command context so that + // it can be retrieved at execution time + executionClientFactory := func() (register.APIClientInterface, error) { + securecabinetv1.SetDebug(securecabinetv1Debug) + return securecabinetv1.NewClient() + } + cmd.SetContext(register.ContextWithClientFactory(cmd.Context(), executionClientFactory)) + }, +} + +func init() { + rootCmd.AddCommand(securecabinetv1Cmd) + + // Add common debug flag that will be inherited by all subcommands for securecabinetv1 + securecabinetv1Cmd.PersistentFlags().BoolVar(&securecabinetv1Debug, "debug", false, "Enable debug logging for HTTP requests") + + // Add common format flag that will be inherited by all subcommands for securecabinetv1 + securecabinetv1Cmd.PersistentFlags().StringP("format", "f", "json", "Format to use for output (json or yaml)") + + // Load SDK descriptions for better command documentation + if err := register.LoadDescriptions(securecabinetv1Descriptions); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Could not load securecabinetv1 descriptions: %v\n", err) + } + + // Register commands at init time for help/discovery + // We use a discovery client that doesn't require credentials for structure introspection + // Actual API calls will validate credentials at runtime + client, err := securecabinetv1.NewClientForDiscovery() + if err != nil { + // If we can't even create a discovery client, log a warning but continue + // Commands won't be available but the CLI won't crash + fmt.Fprintf(os.Stderr, "Warning: Could not register securecabinetv1 commands: %v\n", err) + return + } + + // Register all service commands dynamically + err = register.ServiceCommands(securecabinetv1Cmd, client, "securecabinetv1") + if err != nil { + fmt.Fprintf(os.Stderr, "Warning: Failed to register securecabinetv1 commands: %v\n", err) + } + + // Uncomment and customize aliases as needed for convenience + // Example: Add shorter aliases for commonly used commands + // securecabinetv1Cmd.Aliases = []string{"securecabinet"} + // + // Or add aliases to specific subcommands after registration: + // if connectionsCmd, _, err := securecabinetv1Cmd.Find([]string{"connections"}); err == nil { + // if createCmd, _, err := connectionsCmd.Find([]string{"create-connection"}); err == nil { + // createCmd.Aliases = []string{"create"} + // } + // } +} diff --git a/cmd/smarthandsv1.go b/cmd/smarthandsv1.go new file mode 100644 index 0000000..df5605a --- /dev/null +++ b/cmd/smarthandsv1.go @@ -0,0 +1,80 @@ +package cmd + +import ( + _ "embed" + "fmt" + "os" + + "github.com/equinix/cli/internal/smarthandsv1" + "github.com/equinix/cli/internal/register" + "github.com/spf13/cobra" +) + +// TODO: Put service subcommands in separate packages to +// avoid variable naming collisions +var smarthandsv1Debug bool + +//go:embed descriptions/smarthandsv1.json +var smarthandsv1Descriptions []byte + +// smarthandsv1Cmd represents the smarthandsv1 command +var smarthandsv1Cmd = &cobra.Command{ + Use: "smarthandsv1", + Short: "Manage Equinix smarthandsv1 resources", + Long: `Commands for managing Equinix smarthandsv1 resources. + +The smarthandsv1 commands are dynamically generated based on the smarthandsv1 API client, +providing access to all available API services.`, + PersistentPreRun: func(cmd *cobra.Command, _ []string) { + // Inject the client factory into the command context so that + // it can be retrieved at execution time + executionClientFactory := func() (register.APIClientInterface, error) { + smarthandsv1.SetDebug(smarthandsv1Debug) + return smarthandsv1.NewClient() + } + cmd.SetContext(register.ContextWithClientFactory(cmd.Context(), executionClientFactory)) + }, +} + +func init() { + rootCmd.AddCommand(smarthandsv1Cmd) + + // Add common debug flag that will be inherited by all subcommands for smarthandsv1 + smarthandsv1Cmd.PersistentFlags().BoolVar(&smarthandsv1Debug, "debug", false, "Enable debug logging for HTTP requests") + + // Add common format flag that will be inherited by all subcommands for smarthandsv1 + smarthandsv1Cmd.PersistentFlags().StringP("format", "f", "json", "Format to use for output (json or yaml)") + + // Load SDK descriptions for better command documentation + if err := register.LoadDescriptions(smarthandsv1Descriptions); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Could not load smarthandsv1 descriptions: %v\n", err) + } + + // Register commands at init time for help/discovery + // We use a discovery client that doesn't require credentials for structure introspection + // Actual API calls will validate credentials at runtime + client, err := smarthandsv1.NewClientForDiscovery() + if err != nil { + // If we can't even create a discovery client, log a warning but continue + // Commands won't be available but the CLI won't crash + fmt.Fprintf(os.Stderr, "Warning: Could not register smarthandsv1 commands: %v\n", err) + return + } + + // Register all service commands dynamically + err = register.ServiceCommands(smarthandsv1Cmd, client, "smarthandsv1") + if err != nil { + fmt.Fprintf(os.Stderr, "Warning: Failed to register smarthandsv1 commands: %v\n", err) + } + + // Uncomment and customize aliases as needed for convenience + // Example: Add shorter aliases for commonly used commands + // smarthandsv1Cmd.Aliases = []string{"smarthands"} + // + // Or add aliases to specific subcommands after registration: + // if connectionsCmd, _, err := smarthandsv1Cmd.Find([]string{"connections"}); err == nil { + // if createCmd, _, err := connectionsCmd.Find([]string{"create-connection"}); err == nil { + // createCmd.Aliases = []string{"create"} + // } + // } +} diff --git a/cmd/stsv1alpha.go b/cmd/stsv1alpha.go new file mode 100644 index 0000000..186971a --- /dev/null +++ b/cmd/stsv1alpha.go @@ -0,0 +1,80 @@ +package cmd + +import ( + _ "embed" + "fmt" + "os" + + "github.com/equinix/cli/internal/stsv1alpha" + "github.com/equinix/cli/internal/register" + "github.com/spf13/cobra" +) + +// TODO: Put service subcommands in separate packages to +// avoid variable naming collisions +var stsv1alphaDebug bool + +//go:embed descriptions/stsv1alpha.json +var stsv1alphaDescriptions []byte + +// stsv1alphaCmd represents the stsv1alpha command +var stsv1alphaCmd = &cobra.Command{ + Use: "stsv1alpha", + Short: "Manage Equinix stsv1alpha resources", + Long: `Commands for managing Equinix stsv1alpha resources. + +The stsv1alpha commands are dynamically generated based on the stsv1alpha API client, +providing access to all available API services.`, + PersistentPreRun: func(cmd *cobra.Command, _ []string) { + // Inject the client factory into the command context so that + // it can be retrieved at execution time + executionClientFactory := func() (register.APIClientInterface, error) { + stsv1alpha.SetDebug(stsv1alphaDebug) + return stsv1alpha.NewClient() + } + cmd.SetContext(register.ContextWithClientFactory(cmd.Context(), executionClientFactory)) + }, +} + +func init() { + rootCmd.AddCommand(stsv1alphaCmd) + + // Add common debug flag that will be inherited by all subcommands for stsv1alpha + stsv1alphaCmd.PersistentFlags().BoolVar(&stsv1alphaDebug, "debug", false, "Enable debug logging for HTTP requests") + + // Add common format flag that will be inherited by all subcommands for stsv1alpha + stsv1alphaCmd.PersistentFlags().StringP("format", "f", "json", "Format to use for output (json or yaml)") + + // Load SDK descriptions for better command documentation + if err := register.LoadDescriptions(stsv1alphaDescriptions); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Could not load stsv1alpha descriptions: %v\n", err) + } + + // Register commands at init time for help/discovery + // We use a discovery client that doesn't require credentials for structure introspection + // Actual API calls will validate credentials at runtime + client, err := stsv1alpha.NewClientForDiscovery() + if err != nil { + // If we can't even create a discovery client, log a warning but continue + // Commands won't be available but the CLI won't crash + fmt.Fprintf(os.Stderr, "Warning: Could not register stsv1alpha commands: %v\n", err) + return + } + + // Register all service commands dynamically + err = register.ServiceCommands(stsv1alphaCmd, client, "stsv1alpha") + if err != nil { + fmt.Fprintf(os.Stderr, "Warning: Failed to register stsv1alpha commands: %v\n", err) + } + + // Uncomment and customize aliases as needed for convenience + // Example: Add shorter aliases for commonly used commands + // stsv1alphaCmd.Aliases = []string{"stsv1alpha"} + // + // Or add aliases to specific subcommands after registration: + // if connectionsCmd, _, err := stsv1alphaCmd.Find([]string{"connections"}); err == nil { + // if createCmd, _, err := connectionsCmd.Find([]string{"create-connection"}); err == nil { + // createCmd.Aliases = []string{"create"} + // } + // } +} diff --git a/go.mod b/go.mod index 823fa24..58bedb1 100644 --- a/go.mod +++ b/go.mod @@ -25,5 +25,5 @@ require ( golang.org/x/oauth2 v0.26.0 // indirect golang.org/x/sys v0.29.0 // indirect golang.org/x/text v0.28.0 // indirect - gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect + gopkg.in/validator.v2 v2.0.1 // indirect ) diff --git a/go.sum b/go.sum index 37a07a8..11f0555 100644 --- a/go.sum +++ b/go.sum @@ -14,11 +14,8 @@ github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= -github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= -github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= -github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4= @@ -59,5 +56,7 @@ golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/validator.v2 v2.0.1 h1:xF0KWyGWXm/LM2G1TrEjqOu4pa6coO9AlWSf3msVfDY= +gopkg.in/validator.v2 v2.0.1/go.mod h1:lIUZBlB3Im4s/eYp39Ry/wkR02yOPhZ9IwIRBjuPuG8= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/internal/accesstokenv1/accesstokenv1.go b/internal/accesstokenv1/accesstokenv1.go new file mode 100644 index 0000000..45be3ff --- /dev/null +++ b/internal/accesstokenv1/accesstokenv1.go @@ -0,0 +1,53 @@ +package accesstokenv1 + +import ( + "github.com/equinix/cli/internal/api" + "github.com/equinix/equinix-sdk-go/services/accesstokenv1" +) + +var debugMode bool + +// SetDebug enables or disables debug mode for HTTP requests +func SetDebug(enabled bool) { + debugMode = enabled +} + +// NewClient creates a new accesstokenv1 API client using the standard +// authentication configuration from internal/api +func NewClient() (*accesstokenv1.APIClient, error) { + // Build client options based on debug mode + var opts []api.ClientOption + if debugMode { + opts = append(opts, api.WithDebug()) + } + + // TEMP: use a Metal client for the metalv1 service + // until it is removed from public SDKs + var stdClient *api.Client + var err error + if "accesstokenv1" == "metalv1" { + stdClient, err = api.NewMetalClient(opts...) + } else { + // Use the standard client setup for authentication + stdClient, err = api.NewStandardClient(opts...) + } + + if err != nil { + return nil, err + } + + // Configure the accesstokenv1 client + configuration := accesstokenv1.NewConfiguration() + configuration.HTTPClient = stdClient.HTTPClient + configuration.AddDefaultHeader("X-SOURCE", "equinix-cli") + + return accesstokenv1.NewAPIClient(configuration), nil +} + +// NewClientForDiscovery creates a accesstokenv1 API client for command discovery +// This is used at CLI initialization time to register commands without requiring credentials +func NewClientForDiscovery() (*accesstokenv1.APIClient, error) { + // Create a basic client with no authentication for structure discovery only + configuration := accesstokenv1.NewConfiguration() + return accesstokenv1.NewAPIClient(configuration), nil +} diff --git a/internal/eiav2/eiav2.go b/internal/eiav2/eiav2.go new file mode 100644 index 0000000..4ea8598 --- /dev/null +++ b/internal/eiav2/eiav2.go @@ -0,0 +1,53 @@ +package eiav2 + +import ( + "github.com/equinix/cli/internal/api" + "github.com/equinix/equinix-sdk-go/services/eiav2" +) + +var debugMode bool + +// SetDebug enables or disables debug mode for HTTP requests +func SetDebug(enabled bool) { + debugMode = enabled +} + +// NewClient creates a new eiav2 API client using the standard +// authentication configuration from internal/api +func NewClient() (*eiav2.APIClient, error) { + // Build client options based on debug mode + var opts []api.ClientOption + if debugMode { + opts = append(opts, api.WithDebug()) + } + + // TEMP: use a Metal client for the metalv1 service + // until it is removed from public SDKs + var stdClient *api.Client + var err error + if "eiav2" == "metalv1" { + stdClient, err = api.NewMetalClient(opts...) + } else { + // Use the standard client setup for authentication + stdClient, err = api.NewStandardClient(opts...) + } + + if err != nil { + return nil, err + } + + // Configure the eiav2 client + configuration := eiav2.NewConfiguration() + configuration.HTTPClient = stdClient.HTTPClient + configuration.AddDefaultHeader("X-SOURCE", "equinix-cli") + + return eiav2.NewAPIClient(configuration), nil +} + +// NewClientForDiscovery creates a eiav2 API client for command discovery +// This is used at CLI initialization time to register commands without requiring credentials +func NewClientForDiscovery() (*eiav2.APIClient, error) { + // Create a basic client with no authentication for structure discovery only + configuration := eiav2.NewConfiguration() + return eiav2.NewAPIClient(configuration), nil +} diff --git a/internal/fabricv4/fabricv4.go b/internal/fabricv4/fabricv4.go new file mode 100644 index 0000000..9d0d471 --- /dev/null +++ b/internal/fabricv4/fabricv4.go @@ -0,0 +1,53 @@ +package fabricv4 + +import ( + "github.com/equinix/cli/internal/api" + "github.com/equinix/equinix-sdk-go/services/fabricv4" +) + +var debugMode bool + +// SetDebug enables or disables debug mode for HTTP requests +func SetDebug(enabled bool) { + debugMode = enabled +} + +// NewClient creates a new fauricv4 API client using the standard +// authentication configuration from internal/api +func NewClient() (*fabricv4.APIClient, error) { + // Build client options based on debug mode + var opts []api.ClientOption + if debugMode { + opts = append(opts, api.WithDebug()) + } + + // TEMP: use a Metal client for the metalv1 service + // until it is removed from public SDKs + var stdClient *api.Client + var err error + if "fabricv4" == "metalv1" { + stdClient, err = api.NewMetalClient(opts...) + } else { + // Use the standard client setup for authentication + stdClient, err = api.NewStandardClient(opts...) + } + + if err != nil { + return nil, err + } + + // Configure the fauricv4 client + configuration := fabricv4.NewConfiguration() + configuration.HTTPClient = stdClient.HTTPClient + configuration.AddDefaultHeader("X-SOURCE", "equinix-cli") + + return fabricv4.NewAPIClient(configuration), nil +} + +// NewClientForDiscovery creates a fauricv4 API client for command discovery +// This is used at CLI initialization time to register commands without requiring credentials +func NewClientForDiscovery() (*fabricv4.APIClient, error) { + // Create a basic client with no authentication for structure discovery only + configuration := fabricv4.NewConfiguration() + return fabricv4.NewAPIClient(configuration), nil +} diff --git a/internal/lookupv2/lookupv2.go b/internal/lookupv2/lookupv2.go new file mode 100644 index 0000000..380612a --- /dev/null +++ b/internal/lookupv2/lookupv2.go @@ -0,0 +1,53 @@ +package lookupv2 + +import ( + "github.com/equinix/cli/internal/api" + "github.com/equinix/equinix-sdk-go/services/lookupv2" +) + +var debugMode bool + +// SetDebug enables or disables debug mode for HTTP requests +func SetDebug(enabled bool) { + debugMode = enabled +} + +// NewClient creates a new lookupv2 API client using the standard +// authentication configuration from internal/api +func NewClient() (*lookupv2.APIClient, error) { + // Build client options based on debug mode + var opts []api.ClientOption + if debugMode { + opts = append(opts, api.WithDebug()) + } + + // TEMP: use a Metal client for the metalv1 service + // until it is removed from public SDKs + var stdClient *api.Client + var err error + if "lookupv2" == "metalv1" { + stdClient, err = api.NewMetalClient(opts...) + } else { + // Use the standard client setup for authentication + stdClient, err = api.NewStandardClient(opts...) + } + + if err != nil { + return nil, err + } + + // Configure the lookupv2 client + configuration := lookupv2.NewConfiguration() + configuration.HTTPClient = stdClient.HTTPClient + configuration.AddDefaultHeader("X-SOURCE", "equinix-cli") + + return lookupv2.NewAPIClient(configuration), nil +} + +// NewClientForDiscovery creates a lookupv2 API client for command discovery +// This is used at CLI initialization time to register commands without requiring credentials +func NewClientForDiscovery() (*lookupv2.APIClient, error) { + // Create a basic client with no authentication for structure discovery only + configuration := lookupv2.NewConfiguration() + return lookupv2.NewAPIClient(configuration), nil +} diff --git a/internal/metalv1/metalv1.go b/internal/metalv1/metalv1.go new file mode 100644 index 0000000..258e04f --- /dev/null +++ b/internal/metalv1/metalv1.go @@ -0,0 +1,53 @@ +package metalv1 + +import ( + "github.com/equinix/cli/internal/api" + "github.com/equinix/equinix-sdk-go/services/metalv1" +) + +var debugMode bool + +// SetDebug enables or disables debug mode for HTTP requests +func SetDebug(enabled bool) { + debugMode = enabled +} + +// NewClient creates a new metalv1 API client using the standard +// authentication configuration from internal/api +func NewClient() (*metalv1.APIClient, error) { + // Build client options based on debug mode + var opts []api.ClientOption + if debugMode { + opts = append(opts, api.WithDebug()) + } + + // TEMP: use a Metal client for the metalv1 service + // until it is removed from public SDKs + var stdClient *api.Client + var err error + if "metalv1" == "metalv1" { + stdClient, err = api.NewMetalClient(opts...) + } else { + // Use the standard client setup for authentication + stdClient, err = api.NewStandardClient(opts...) + } + + if err != nil { + return nil, err + } + + // Configure the metalv1 client + configuration := metalv1.NewConfiguration() + configuration.HTTPClient = stdClient.HTTPClient + configuration.AddDefaultHeader("X-SOURCE", "equinix-cli") + + return metalv1.NewAPIClient(configuration), nil +} + +// NewClientForDiscovery creates a metalv1 API client for command discovery +// This is used at CLI initialization time to register commands without requiring credentials +func NewClientForDiscovery() (*metalv1.APIClient, error) { + // Create a basic client with no authentication for structure discovery only + configuration := metalv1.NewConfiguration() + return metalv1.NewAPIClient(configuration), nil +} diff --git a/internal/orderhistoryv1/orderhistoryv1.go b/internal/orderhistoryv1/orderhistoryv1.go new file mode 100644 index 0000000..1a56f51 --- /dev/null +++ b/internal/orderhistoryv1/orderhistoryv1.go @@ -0,0 +1,53 @@ +package orderhistoryv1 + +import ( + "github.com/equinix/cli/internal/api" + "github.com/equinix/equinix-sdk-go/services/orderhistoryv1" +) + +var debugMode bool + +// SetDebug enables or disables debug mode for HTTP requests +func SetDebug(enabled bool) { + debugMode = enabled +} + +// NewClient creates a new orderhistoryv1 API client using the standard +// authentication configuration from internal/api +func NewClient() (*orderhistoryv1.APIClient, error) { + // Build client options based on debug mode + var opts []api.ClientOption + if debugMode { + opts = append(opts, api.WithDebug()) + } + + // TEMP: use a Metal client for the metalv1 service + // until it is removed from public SDKs + var stdClient *api.Client + var err error + if "orderhistoryv1" == "metalv1" { + stdClient, err = api.NewMetalClient(opts...) + } else { + // Use the standard client setup for authentication + stdClient, err = api.NewStandardClient(opts...) + } + + if err != nil { + return nil, err + } + + // Configure the orderhistoryv1 client + configuration := orderhistoryv1.NewConfiguration() + configuration.HTTPClient = stdClient.HTTPClient + configuration.AddDefaultHeader("X-SOURCE", "equinix-cli") + + return orderhistoryv1.NewAPIClient(configuration), nil +} + +// NewClientForDiscovery creates a orderhistoryv1 API client for command discovery +// This is used at CLI initialization time to register commands without requiring credentials +func NewClientForDiscovery() (*orderhistoryv1.APIClient, error) { + // Create a basic client with no authentication for structure discovery only + configuration := orderhistoryv1.NewConfiguration() + return orderhistoryv1.NewAPIClient(configuration), nil +} diff --git a/internal/ordersv2/ordersv2.go b/internal/ordersv2/ordersv2.go new file mode 100644 index 0000000..89ecd3a --- /dev/null +++ b/internal/ordersv2/ordersv2.go @@ -0,0 +1,53 @@ +package ordersv2 + +import ( + "github.com/equinix/cli/internal/api" + "github.com/equinix/equinix-sdk-go/services/ordersv2" +) + +var debugMode bool + +// SetDebug enables or disables debug mode for HTTP requests +func SetDebug(enabled bool) { + debugMode = enabled +} + +// NewClient creates a new ordersv2 API client using the standard +// authentication configuration from internal/api +func NewClient() (*ordersv2.APIClient, error) { + // Build client options based on debug mode + var opts []api.ClientOption + if debugMode { + opts = append(opts, api.WithDebug()) + } + + // TEMP: use a Metal client for the metalv1 service + // until it is removed from public SDKs + var stdClient *api.Client + var err error + if "ordersv2" == "metalv1" { + stdClient, err = api.NewMetalClient(opts...) + } else { + // Use the standard client setup for authentication + stdClient, err = api.NewStandardClient(opts...) + } + + if err != nil { + return nil, err + } + + // Configure the ordersv2 client + configuration := ordersv2.NewConfiguration() + configuration.HTTPClient = stdClient.HTTPClient + configuration.AddDefaultHeader("X-SOURCE", "equinix-cli") + + return ordersv2.NewAPIClient(configuration), nil +} + +// NewClientForDiscovery creates a ordersv2 API client for command discovery +// This is used at CLI initialization time to register commands without requiring credentials +func NewClientForDiscovery() (*ordersv2.APIClient, error) { + // Create a basic client with no authentication for structure discovery only + configuration := ordersv2.NewConfiguration() + return ordersv2.NewAPIClient(configuration), nil +} diff --git a/internal/securecabinetv1/securecabinetv1.go b/internal/securecabinetv1/securecabinetv1.go new file mode 100644 index 0000000..bc65f9c --- /dev/null +++ b/internal/securecabinetv1/securecabinetv1.go @@ -0,0 +1,53 @@ +package securecabinetv1 + +import ( + "github.com/equinix/cli/internal/api" + "github.com/equinix/equinix-sdk-go/services/securecabinetv1" +) + +var debugMode bool + +// SetDebug enables or disables debug mode for HTTP requests +func SetDebug(enabled bool) { + debugMode = enabled +} + +// NewClient creates a new securecauinetv1 API client using the standard +// authentication configuration from internal/api +func NewClient() (*securecabinetv1.APIClient, error) { + // Build client options based on debug mode + var opts []api.ClientOption + if debugMode { + opts = append(opts, api.WithDebug()) + } + + // TEMP: use a Metal client for the metalv1 service + // until it is removed from public SDKs + var stdClient *api.Client + var err error + if "securecabinetv1" == "metalv1" { + stdClient, err = api.NewMetalClient(opts...) + } else { + // Use the standard client setup for authentication + stdClient, err = api.NewStandardClient(opts...) + } + + if err != nil { + return nil, err + } + + // Configure the securecauinetv1 client + configuration := securecabinetv1.NewConfiguration() + configuration.HTTPClient = stdClient.HTTPClient + configuration.AddDefaultHeader("X-SOURCE", "equinix-cli") + + return securecabinetv1.NewAPIClient(configuration), nil +} + +// NewClientForDiscovery creates a securecauinetv1 API client for command discovery +// This is used at CLI initialization time to register commands without requiring credentials +func NewClientForDiscovery() (*securecabinetv1.APIClient, error) { + // Create a basic client with no authentication for structure discovery only + configuration := securecabinetv1.NewConfiguration() + return securecabinetv1.NewAPIClient(configuration), nil +} diff --git a/internal/smarthandsv1/smarthandsv1.go b/internal/smarthandsv1/smarthandsv1.go new file mode 100644 index 0000000..27e817d --- /dev/null +++ b/internal/smarthandsv1/smarthandsv1.go @@ -0,0 +1,53 @@ +package smarthandsv1 + +import ( + "github.com/equinix/cli/internal/api" + "github.com/equinix/equinix-sdk-go/services/smarthandsv1" +) + +var debugMode bool + +// SetDebug enables or disables debug mode for HTTP requests +func SetDebug(enabled bool) { + debugMode = enabled +} + +// NewClient creates a new smarthandsv1 API client using the standard +// authentication configuration from internal/api +func NewClient() (*smarthandsv1.APIClient, error) { + // Build client options based on debug mode + var opts []api.ClientOption + if debugMode { + opts = append(opts, api.WithDebug()) + } + + // TEMP: use a Metal client for the metalv1 service + // until it is removed from public SDKs + var stdClient *api.Client + var err error + if "smarthandsv1" == "metalv1" { + stdClient, err = api.NewMetalClient(opts...) + } else { + // Use the standard client setup for authentication + stdClient, err = api.NewStandardClient(opts...) + } + + if err != nil { + return nil, err + } + + // Configure the smarthandsv1 client + configuration := smarthandsv1.NewConfiguration() + configuration.HTTPClient = stdClient.HTTPClient + configuration.AddDefaultHeader("X-SOURCE", "equinix-cli") + + return smarthandsv1.NewAPIClient(configuration), nil +} + +// NewClientForDiscovery creates a smarthandsv1 API client for command discovery +// This is used at CLI initialization time to register commands without requiring credentials +func NewClientForDiscovery() (*smarthandsv1.APIClient, error) { + // Create a basic client with no authentication for structure discovery only + configuration := smarthandsv1.NewConfiguration() + return smarthandsv1.NewAPIClient(configuration), nil +} diff --git a/internal/stsv1alpha/stsv1alpha.go b/internal/stsv1alpha/stsv1alpha.go new file mode 100644 index 0000000..01a2f0c --- /dev/null +++ b/internal/stsv1alpha/stsv1alpha.go @@ -0,0 +1,53 @@ +package stsv1alpha + +import ( + "github.com/equinix/cli/internal/api" + "github.com/equinix/equinix-sdk-go/services/stsv1alpha" +) + +var debugMode bool + +// SetDebug enables or disables debug mode for HTTP requests +func SetDebug(enabled bool) { + debugMode = enabled +} + +// NewClient creates a new stsv1alpha API client using the standard +// authentication configuration from internal/api +func NewClient() (*stsv1alpha.APIClient, error) { + // Build client options based on debug mode + var opts []api.ClientOption + if debugMode { + opts = append(opts, api.WithDebug()) + } + + // TEMP: use a Metal client for the metalv1 service + // until it is removed from public SDKs + var stdClient *api.Client + var err error + if "stsv1alpha" == "metalv1" { + stdClient, err = api.NewMetalClient(opts...) + } else { + // Use the standard client setup for authentication + stdClient, err = api.NewStandardClient(opts...) + } + + if err != nil { + return nil, err + } + + // Configure the stsv1alpha client + configuration := stsv1alpha.NewConfiguration() + configuration.HTTPClient = stdClient.HTTPClient + configuration.AddDefaultHeader("X-SOURCE", "equinix-cli") + + return stsv1alpha.NewAPIClient(configuration), nil +} + +// NewClientForDiscovery creates a stsv1alpha API client for command discovery +// This is used at CLI initialization time to register commands without requiring credentials +func NewClientForDiscovery() (*stsv1alpha.APIClient, error) { + // Create a basic client with no authentication for structure discovery only + configuration := stsv1alpha.NewConfiguration() + return stsv1alpha.NewAPIClient(configuration), nil +} From ca5454624ecd9c572ef014400e78f526a67e7827 Mon Sep 17 00:00:00 2001 From: Charles Treatman Date: Wed, 17 Dec 2025 11:15:53 -0600 Subject: [PATCH 4/5] run make fix --- cmd/securecabinetv1.go | 2 +- cmd/smarthandsv1.go | 2 +- cmd/stsv1alpha.go | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cmd/securecabinetv1.go b/cmd/securecabinetv1.go index 1861265..347d7a5 100644 --- a/cmd/securecabinetv1.go +++ b/cmd/securecabinetv1.go @@ -5,8 +5,8 @@ import ( "fmt" "os" - "github.com/equinix/cli/internal/securecabinetv1" "github.com/equinix/cli/internal/register" + "github.com/equinix/cli/internal/securecabinetv1" "github.com/spf13/cobra" ) diff --git a/cmd/smarthandsv1.go b/cmd/smarthandsv1.go index df5605a..9e15d2c 100644 --- a/cmd/smarthandsv1.go +++ b/cmd/smarthandsv1.go @@ -5,8 +5,8 @@ import ( "fmt" "os" - "github.com/equinix/cli/internal/smarthandsv1" "github.com/equinix/cli/internal/register" + "github.com/equinix/cli/internal/smarthandsv1" "github.com/spf13/cobra" ) diff --git a/cmd/stsv1alpha.go b/cmd/stsv1alpha.go index 186971a..a75274a 100644 --- a/cmd/stsv1alpha.go +++ b/cmd/stsv1alpha.go @@ -5,8 +5,8 @@ import ( "fmt" "os" - "github.com/equinix/cli/internal/stsv1alpha" "github.com/equinix/cli/internal/register" + "github.com/equinix/cli/internal/stsv1alpha" "github.com/spf13/cobra" ) From cb6b418ddbe4c29fc8cd435fc3d19b5658e3f0de Mon Sep 17 00:00:00 2001 From: Charles Treatman Date: Wed, 17 Dec 2025 11:16:07 -0600 Subject: [PATCH 5/5] run make docs --- docs/equinix.md | 10 ++ docs/equinix_accesstokenv1.md | 30 ++++ docs/equinix_accesstokenv1_o-auth2-token.md | 28 +++ ..._o-auth2-token_get-o-auth2-access-token.md | 40 +++++ ...uth2-token_refresh-o-auth2-access-token.md | 37 ++++ docs/equinix_eiav2.md | 30 ++++ docs/equinix_eiav2_e-i-a-service.md | 27 +++ ...ervice_create-equinix-internet-accessv2.md | 52 ++++++ docs/equinix_fabricv4.md | 52 ++++++ docs/equinix_fabricv4_cloud-events.md | 29 ++++ ...loud-events_get-cloud-event-by-asset-id.md | 37 ++++ ...x_fabricv4_cloud-events_get-cloud-event.md | 34 ++++ ...bricv4_cloud-events_search-cloud-events.md | 39 +++++ docs/equinix_fabricv4_cloud-routers.md | 47 +++++ ...loud-routers_create-cloud-router-action.md | 41 +++++ ...oud-routers_create-cloud-router-command.md | 47 +++++ ...ricv4_cloud-routers_create-cloud-router.md | 73 ++++++++ ...oud-routers_delete-cloud-router-by-uuid.md | 34 ++++ ...ers_delete-cloud-router-command-by-uuid.md | 35 ++++ ...d-routers_get-all-cloud-router-commands.md | 34 ++++ ...outers_get-cloud-router-actions-by-uuid.md | 36 ++++ ..._cloud-routers_get-cloud-router-actions.md | 35 ++++ ..._cloud-routers_get-cloud-router-by-uuid.md | 34 ++++ ..._cloud-routers_get-cloud-router-command.md | 35 ++++ ...outers_get-cloud-router-package-by-code.md | 34 ++++ ...cloud-routers_get-cloud-router-packages.md | 35 ++++ ...eway-attachment-to-cloud-router-by-uuid.md | 35 ++++ ...ist-gateway-attachments-to-cloud-router.md | 36 ++++ ...ud-routers_search-cloud-router-commands.md | 41 +++++ ...loud-routers_search-cloud-router-routes.md | 41 +++++ ...icv4_cloud-routers_search-cloud-routers.md | 40 +++++ ...ers_search-connection-advertised-routes.md | 41 +++++ ...uters_search-connection-received-routes.md | 41 +++++ ...cv4_cloud-routers_search-router-actions.md | 41 +++++ ...oud-routers_update-cloud-router-by-uuid.md | 35 ++++ docs/equinix_fabricv4_connections.md | 33 ++++ ...v4_connections_create-connection-action.md | 40 +++++ ..._fabricv4_connections_create-connection.md | 75 ++++++++ ...4_connections_delete-connection-by-uuid.md | 34 ++++ ...icv4_connections_get-connection-by-uuid.md | 35 ++++ ...fabricv4_connections_search-connections.md | 44 +++++ ...4_connections_update-connection-by-uuid.md | 36 ++++ ...bricv4_connections_validate-connections.md | 36 ++++ docs/equinix_fabricv4_health.md | 27 +++ docs/equinix_fabricv4_health_get-status.md | 33 ++++ ...inix_fabricv4_marketplace-subscriptions.md | 27 +++ ...ce-subscriptions_get-subscription-by-id.md | 34 ++++ docs/equinix_fabricv4_metrics.md | 28 +++ ...fabricv4_metrics_get-metric-by-asset-id.md | 38 ++++ ...equinix_fabricv4_metrics_search-metrics.md | 39 +++++ docs/equinix_fabricv4_metros.md | 28 +++ ...uinix_fabricv4_metros_get-metro-by-code.md | 34 ++++ docs/equinix_fabricv4_metros_get-metros.md | 36 ++++ docs/equinix_fabricv4_networks.md | 34 ++++ ...quinix_fabricv4_networks_create-network.md | 47 +++++ ...abricv4_networks_delete-network-by-uuid.md | 34 ++++ ...etworks_get-connections-by-network-uuid.md | 34 ++++ ...x_fabricv4_networks_get-network-by-uuid.md | 34 ++++ ...cv4_networks_get-network-change-by-uuid.md | 35 ++++ ...x_fabricv4_networks_get-network-changes.md | 34 ++++ ...uinix_fabricv4_networks_search-networks.md | 44 +++++ ...abricv4_networks_update-network-by-uuid.md | 35 ++++ docs/equinix_fabricv4_port-packages.md | 27 +++ ...abricv4_port-packages_get-port-packages.md | 33 ++++ docs/equinix_fabricv4_ports.md | 34 ++++ docs/equinix_fabricv4_ports_add-to-lag.md | 36 ++++ docs/equinix_fabricv4_ports_create-port.md | 162 ++++++++++++++++++ docs/equinix_fabricv4_ports_delete-port.md | 35 ++++ ...equinix_fabricv4_ports_get-port-by-uuid.md | 34 ++++ docs/equinix_fabricv4_ports_get-ports.md | 34 ++++ docs/equinix_fabricv4_ports_get-vlans.md | 34 ++++ docs/equinix_fabricv4_ports_search-ports.md | 44 +++++ ...inix_fabricv4_ports_update-port-by-uuid.md | 36 ++++ docs/equinix_fabricv4_precision-time.md | 35 ++++ ...cv4_precision-time_create-time-services.md | 61 +++++++ ...recision-time_delete-time-service-by-id.md | 34 ++++ ...v4_precision-time_fulfill-time-services.md | 62 +++++++ ..._precision-time_get-time-services-by-id.md | 34 ++++ ...time-services-connections-by-service-id.md | 34 ++++ ...-time_get-time-services-package-by-code.md | 34 ++++ ...ecision-time_get-time-services-packages.md | 33 ++++ ...cv4_precision-time_search-time-services.md | 40 +++++ ...ecision-time_update-time-services-by-id.md | 35 ++++ docs/equinix_fabricv4_prices.md | 27 +++ docs/equinix_fabricv4_prices_search-prices.md | 40 +++++ ...quinix_fabricv4_route-aggregation-rules.md | 35 ++++ ...ion-rules_create-route-aggregation-rule.md | 38 ++++ ..._create-route-aggregation-rules-in-bulk.md | 36 ++++ ...s_delete-route-aggregation-rule-by-uuid.md | 35 ++++ ...ules_get-route-aggregation-rule-by-uuid.md | 35 ++++ ...t-route-aggregation-rule-change-by-uuid.md | 36 ++++ ...ules_get-route-aggregation-rule-changes.md | 37 ++++ ...ation-rules_get-route-aggregation-rules.md | 36 ++++ ...es_patch-route-aggregation-rule-by-uuid.md | 36 ++++ ..._replace-route-aggregation-rule-by-uuid.md | 39 +++++ docs/equinix_fabricv4_route-aggregations.md | 38 ++++ ...ons_attach-connection-route-aggregation.md | 35 ++++ ...e-aggregations_create-route-aggregation.md | 39 +++++ ...ations_delete-route-aggregation-by-uuid.md | 34 ++++ ...ons_detach-connection-route-aggregation.md | 35 ++++ ...et-connection-route-aggregation-by-uuid.md | 35 ++++ ...tions_get-connection-route-aggregations.md | 34 ++++ ...regations_get-route-aggregation-by-uuid.md | 34 ++++ ...ns_get-route-aggregation-change-by-uuid.md | 35 ++++ ...regations_get-route-aggregation-changes.md | 36 ++++ ...tions_get-route-aggregation-connections.md | 34 ++++ ...gations_patch-route-aggregation-by-uuid.md | 35 ++++ ...-aggregations_search-route-aggregations.md | 43 +++++ docs/equinix_fabricv4_route-filter-rules.md | 35 ++++ ...e-filter-rules_create-route-filter-rule.md | 39 +++++ ...rules_create-route-filter-rules-in-bulk.md | 36 ++++ ...-rules_delete-route-filter-rule-by-uuid.md | 35 ++++ ...ter-rules_get-route-filter-rule-by-uuid.md | 35 ++++ ...es_get-route-filter-rule-change-by-uuid.md | 36 ++++ ...ter-rules_get-route-filter-rule-changes.md | 37 ++++ ...ute-filter-rules_get-route-filter-rules.md | 36 ++++ ...r-rules_patch-route-filter-rule-by-uuid.md | 36 ++++ ...rules_replace-route-filter-rule-by-uuid.md | 40 +++++ docs/equinix_fabricv4_route-filters.md | 38 ++++ ...-filters_attach-connection-route-filter.md | 37 ++++ ...ricv4_route-filters_create-route-filter.md | 39 +++++ ...ute-filters_delete-route-filter-by-uuid.md | 34 ++++ ...-filters_detach-connection-route-filter.md | 35 ++++ ...ers_get-connection-route-filter-by-uuid.md | 35 ++++ ...te-filters_get-connection-route-filters.md | 34 ++++ ..._route-filters_get-route-filter-by-uuid.md | 34 ++++ ...filters_get-route-filter-change-by-uuid.md | 35 ++++ ..._route-filters_get-route-filter-changes.md | 36 ++++ ...te-filters_get-route-filter-connections.md | 34 ++++ ...oute-filters_patch-route-filter-by-uuid.md | 35 ++++ ...icv4_route-filters_search-route-filters.md | 43 +++++ docs/equinix_fabricv4_routing-protocols.md | 39 +++++ ...cols_create-connection-routing-protocol.md | 48 ++++++ ...te-connection-routing-protocols-in-bulk.md | 36 ++++ ...ete-connection-routing-protocol-by-uuid.md | 35 ++++ ...ection-routing-protocol-all-bgp-actions.md | 37 ++++ ...get-connection-routing-protocol-by-uuid.md | 35 ++++ ...on-routing-protocols-bgp-action-by-uuid.md | 36 ++++ ...ection-routing-protocols-change-by-uuid.md | 36 ++++ ...et-connection-routing-protocols-changes.md | 37 ++++ ...tocols_get-connection-routing-protocols.md | 36 ++++ ...tch-connection-routing-protocol-by-uuid.md | 36 ++++ ...ion-routing-protocol-bgp-action-by-uuid.md | 37 ++++ ...ace-connection-routing-protocol-by-uuid.md | 49 ++++++ ...ing-protocols_validate-routing-protocol.md | 37 ++++ docs/equinix_fabricv4_service-profiles.md | 34 ++++ ...service-profiles_create-service-profile.md | 56 ++++++ ...profiles_delete-service-profile-by-uuid.md | 34 ++++ ...ce-profiles_get-service-profile-by-uuid.md | 35 ++++ ...iles_get-service-profile-metros-by-uuid.md | 36 ++++ ...4_service-profiles_get-service-profiles.md | 36 ++++ ...ce-profiles_put-service-profile-by-uuid.md | 58 +++++++ ...ervice-profiles_search-service-profiles.md | 41 +++++ ...profiles_update-service-profile-by-uuid.md | 36 ++++ docs/equinix_fabricv4_service-tokens.md | 33 ++++ ...vice-tokens_create-service-token-action.md | 36 ++++ ...cv4_service-tokens_create-service-token.md | 83 +++++++++ ...ice-tokens_delete-service-token-by-uuid.md | 34 ++++ ...ervice-tokens_get-service-token-by-uuid.md | 34 ++++ ...ricv4_service-tokens_get-service-tokens.md | 35 ++++ ...v4_service-tokens_search-service-tokens.md | 44 +++++ ...ice-tokens_update-service-token-by-uuid.md | 36 ++++ docs/equinix_fabricv4_statistics.md | 28 +++ ...stics_get-connection-stats-by-port-uuid.md | 35 ++++ ..._statistics_get-port-stats-by-port-uuid.md | 34 ++++ docs/equinix_fabricv4_stream-alert-rules.md | 31 ++++ ...m-alert-rules_create-stream-alert-rules.md | 49 ++++++ ...-rules_delete-stream-alert-rule-by-uuid.md | 35 ++++ ...ert-rules_get-stream-alert-rule-by-uuid.md | 35 ++++ ...ream-alert-rules_get-stream-alert-rules.md | 36 ++++ ...-rules_update-stream-alert-rule-by-uuid.md | 50 ++++++ docs/equinix_fabricv4_stream-subscriptions.md | 31 ++++ ...bscriptions_create-stream-subscriptions.md | 54 ++++++ ...ions_delete-stream-subscription-by-uuid.md | 35 ++++ ...iptions_get-stream-subscription-by-uuid.md | 35 ++++ ...-subscriptions_get-stream-subscriptions.md | 36 ++++ ...ions_update-stream-subscription-by-uuid.md | 57 ++++++ docs/equinix_fabricv4_streams.md | 35 ++++ ...equinix_fabricv4_streams_create-streams.md | 39 +++++ ...cv4_streams_delete-stream-asset-by-uuid.md | 36 ++++ ..._fabricv4_streams_delete-stream-by-uuid.md | 34 ++++ ...bricv4_streams_get-stream-asset-by-uuid.md | 36 ++++ ...nix_fabricv4_streams_get-stream-by-uuid.md | 34 ++++ ...nix_fabricv4_streams_get-streams-assets.md | 42 +++++ docs/equinix_fabricv4_streams_get-streams.md | 35 ++++ ...cv4_streams_update-stream-asset-by-uuid.md | 38 ++++ ..._fabricv4_streams_update-stream-by-uuid.md | 37 ++++ docs/equinix_lookupv2.md | 30 ++++ docs/equinix_lookupv2_lookup.md | 31 ++++ ...lookup_get-locations-by-permission-code.md | 39 +++++ ...okupv2_lookup_retrieve-all-patch-panels.md | 37 ++++ ...up_retrieve-list-of-connection-services.md | 34 ++++ ...kupv2_lookup_retrieve-list-of-providers.md | 35 ++++ ...pv2_lookup_retrieve-patch-panel-details.md | 37 ++++ docs/equinix_metalv1.md | 68 ++++++++ docs/equinix_metalv1_authentication.md | 32 ++++ ...metalv1_authentication_create-a-p-i-key.md | 37 ++++ ...authentication_create-project-a-p-i-key.md | 38 ++++ ...metalv1_authentication_delete-a-p-i-key.md | 34 ++++ ...v1_authentication_delete-user-a-p-i-key.md | 34 ++++ ..._metalv1_authentication_find-a-p-i-keys.md | 35 ++++ ..._authentication_find-project-a-p-i-keys.md | 35 ++++ docs/equinix_metalv1_b-g-p.md | 33 ++++ ...quinix_metalv1_b-g-p_delete-bgp-session.md | 37 ++++ ...etalv1_b-g-p_find-bgp-config-by-project.md | 38 ++++ ...ix_metalv1_b-g-p_find-bgp-session-by-id.md | 38 ++++ ...ix_metalv1_b-g-p_find-global-bgp-ranges.md | 37 ++++ ...metalv1_b-g-p_find-project-bgp-sessions.md | 37 ++++ ...quinix_metalv1_b-g-p_request-bgp-config.md | 43 +++++ ...quinix_metalv1_b-g-p_update-bgp-session.md | 38 ++++ docs/equinix_metalv1_batches.md | 30 ++++ ...nix_metalv1_batches_create-device-batch.md | 36 ++++ docs/equinix_metalv1_batches_delete-batch.md | 35 ++++ ...quinix_metalv1_batches_find-batch-by-id.md | 35 ++++ ...metalv1_batches_find-batches-by-project.md | 35 ++++ docs/equinix_metalv1_capacity.md | 32 ++++ ...v1_capacity_check-capacity-for-facility.md | 35 ++++ ...talv1_capacity_check-capacity-for-metro.md | 35 ++++ ...lv1_capacity_find-capacity-for-facility.md | 33 ++++ ...etalv1_capacity_find-capacity-for-metro.md | 33 ++++ ...find-organization-capacity-per-facility.md | 34 ++++ ...ty_find-organization-capacity-per-metro.md | 34 ++++ docs/equinix_metalv1_console-log-details.md | 27 +++ ..._console-log-details_capture-screenshot.md | 34 ++++ docs/equinix_metalv1_devices.md | 46 +++++ ...inix_metalv1_devices_create-bgp-session.md | 38 ++++ docs/equinix_metalv1_devices_create-device.md | 91 ++++++++++ ...x_metalv1_devices_create-i-p-assignment.md | 39 +++++ docs/equinix_metalv1_devices_delete-device.md | 35 ++++ ...uinix_metalv1_devices_find-bgp-sessions.md | 35 ++++ ...uinix_metalv1_devices_find-device-by-id.md | 36 ++++ ..._metalv1_devices_find-device-customdata.md | 34 ++++ ...lv1_devices_find-device-metadata-by-i-d.md | 34 ++++ ...lv1_devices_find-device-userdata-by-i-d.md | 34 ++++ ..._devices_find-i-p-assignment-customdata.md | 35 ++++ ...ix_metalv1_devices_find-i-p-assignments.md | 36 ++++ ...metalv1_devices_find-instance-bandwidth.md | 36 ++++ ...talv1_devices_find-organization-devices.md | 47 +++++ ...ix_metalv1_devices_find-project-devices.md | 48 ++++++ docs/equinix_metalv1_devices_find-traffic.md | 38 ++++ ...x_metalv1_devices_get-bgp-neighbor-data.md | 35 ++++ ...etalv1_devices_get-device-firmware-sets.md | 34 ++++ ...etalv1_devices_get-device-health-rollup.md | 34 ++++ .../equinix_metalv1_devices_perform-action.md | 41 +++++ docs/equinix_metalv1_devices_update-device.md | 49 ++++++ docs/equinix_metalv1_emails.md | 30 ++++ docs/equinix_metalv1_emails_create-email.md | 35 ++++ docs/equinix_metalv1_emails_delete-email.md | 34 ++++ ...equinix_metalv1_emails_find-email-by-id.md | 34 ++++ docs/equinix_metalv1_emails_update-email.md | 36 ++++ docs/equinix_metalv1_events.md | 35 ++++ ...uinix_metalv1_events_find-device-events.md | 38 ++++ ...equinix_metalv1_events_find-event-by-id.md | 36 ++++ docs/equinix_metalv1_events_find-events.md | 37 ++++ ...alv1_events_find-interconnection-events.md | 38 ++++ ...events_find-interconnection-port-events.md | 39 +++++ ...metalv1_events_find-organization-events.md | 38 ++++ ...inix_metalv1_events_find-project-events.md | 38 ++++ ...alv1_events_find-virtual-circuit-events.md | 38 ++++ ...ix_metalv1_events_find-vrf-route-events.md | 38 ++++ docs/equinix_metalv1_facilities.md | 29 ++++ ...ilities_find-facilities-by-organization.md | 36 ++++ ...1_facilities_find-facilities-by-project.md | 36 ++++ ...inix_metalv1_facilities_find-facilities.md | 35 ++++ docs/equinix_metalv1_firmware-sets.md | 28 +++ ...are-sets_get-organization-firmware-sets.md | 36 ++++ ...firmware-sets_get-project-firmware-sets.md | 36 ++++ docs/equinix_metalv1_hardware-reservations.md | 30 ++++ ...ervations_activate-hardware-reservation.md | 38 ++++ ...vations_find-hardware-reservation-by-id.md | 36 ++++ ...ions_find-project-hardware-reservations.md | 41 +++++ ...-reservations_move-hardware-reservation.md | 38 ++++ 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 ++++ ...lv1_i-p-addresses_find-i-p-reservations.md | 42 +++++ ...1_i-p-addresses_request-i-p-reservation.md | 57 ++++++ ...etalv1_i-p-addresses_update-i-p-address.md | 43 +++++ docs/equinix_metalv1_incidents.md | 27 +++ ...quinix_metalv1_incidents_find-incidents.md | 35 ++++ docs/equinix_metalv1_interconnections.md | 43 +++++ ...te-interconnection-port-virtual-circuit.md | 59 +++++++ ...ons_create-organization-interconnection.md | 97 +++++++++++ ...nections_create-project-interconnection.md | 97 +++++++++++ ...interconnections_delete-interconnection.md | 36 ++++ ...interconnections_delete-virtual-circuit.md | 36 ++++ ...rconnections_get-interconnection-metros.md | 33 ++++ ...terconnections_get-interconnection-port.md | 37 ++++ ...connections_get-interconnection-pricing.md | 33 ++++ ...v1_interconnections_get-interconnection.md | 36 ++++ ...v1_interconnections_get-virtual-circuit.md | 36 ++++ ...t-interconnection-port-virtual-circuits.md | 37 ++++ ...rconnections_list-interconnection-ports.md | 34 ++++ ...s_list-interconnection-virtual-circuits.md | 34 ++++ ...ions_organization-list-interconnections.md | 36 ++++ ...nnections_project-list-interconnections.md | 38 ++++ ...interconnections_update-interconnection.md | 42 +++++ ...interconnections_update-virtual-circuit.md | 55 ++++++ docs/equinix_metalv1_invitations.md | 29 ++++ ...x_metalv1_invitations_accept-invitation.md | 35 ++++ ..._metalv1_invitations_decline-invitation.md | 34 ++++ ...talv1_invitations_find-invitation-by-id.md | 35 ++++ docs/equinix_metalv1_invoices.md | 28 +++ ...lv1_invoices_find-organization-invoices.md | 37 ++++ ...inix_metalv1_invoices_get-invoice-by-id.md | 34 ++++ docs/equinix_metalv1_licenses.md | 31 ++++ ...equinix_metalv1_licenses_create-license.md | 40 +++++ ...equinix_metalv1_licenses_delete-license.md | 34 ++++ ...nix_metalv1_licenses_find-license-by-id.md | 36 ++++ ..._metalv1_licenses_find-project-licenses.md | 38 ++++ ...equinix_metalv1_licenses_update-license.md | 39 +++++ docs/equinix_metalv1_memberships.md | 29 ++++ ...x_metalv1_memberships_delete-membership.md | 34 ++++ ...talv1_memberships_find-membership-by-id.md | 35 ++++ ...x_metalv1_memberships_update-membership.md | 37 ++++ docs/equinix_metalv1_metal-gateways.md | 34 ++++ ...al-gateways_create-bgp-dynamic-neighbor.md | 40 +++++ ...ateways_create-metal-gateway-elastic-ip.md | 41 +++++ ...lv1_metal-gateways_create-metal-gateway.md | 45 +++++ ...lv1_metal-gateways_delete-metal-gateway.md | 36 ++++ ...metal-gateways_find-metal-gateway-by-id.md | 36 ++++ ...gateways_find-metal-gateways-by-project.md | 38 ++++ ...etal-gateways_get-bgp-dynamic-neighbors.md | 36 ++++ ...-gateways_get-metal-gateway-elastic-ips.md | 36 ++++ docs/equinix_metalv1_metros.md | 28 +++ docs/equinix_metalv1_metros_find-metros.md | 33 ++++ docs/equinix_metalv1_metros_get-metro.md | 34 ++++ docs/equinix_metalv1_operating-systems.md | 28 +++ ...g-systems_find-operating-system-version.md | 33 ++++ ...perating-systems_find-operating-systems.md | 33 ++++ docs/equinix_metalv1_organizations.md | 41 +++++ ...izations_create-organization-invitation.md | 41 +++++ ...ganizations_create-organization-project.md | 42 +++++ ...talv1_organizations_create-organization.md | 57 ++++++ ...lv1_organizations_create-payment-method.md | 39 +++++ ...talv1_organizations_delete-organization.md | 34 ++++ ..._find-operating-systems-by-organization.md | 35 ++++ ...1_organizations_find-organization-by-id.md | 36 ++++ ...anizations_find-organization-customdata.md | 34 ++++ ...nizations_find-organization-invitations.md | 37 ++++ ...tions_find-organization-payment-methods.md | 37 ++++ ...rganizations_find-organization-projects.md | 39 +++++ ...ganizations_find-organization-transfers.md | 35 ++++ ...etalv1_organizations_find-organizations.md | 39 +++++ ...rganizations_find-plans-by-organization.md | 36 ++++ ...talv1_organizations_update-organization.md | 58 +++++++ docs/equinix_metalv1_password-reset-tokens.md | 28 +++ ...eset-tokens_create-password-reset-token.md | 34 ++++ ...v1_password-reset-tokens_reset-password.md | 33 ++++ docs/equinix_metalv1_payment-methods.md | 29 ++++ ...1_payment-methods_delete-payment-method.md | 34 ++++ ...yment-methods_find-payment-method-by-id.md | 35 ++++ ...1_payment-methods_update-payment-method.md | 42 +++++ docs/equinix_metalv1_plans.md | 28 +++ ...nix_metalv1_plans_find-plans-by-project.md | 36 ++++ docs/equinix_metalv1_plans_find-plans.md | 38 ++++ docs/equinix_metalv1_ports.md | 40 +++++ ...quinix_metalv1_ports_assign-native-vlan.md | 36 ++++ docs/equinix_metalv1_ports_assign-port.md | 37 ++++ docs/equinix_metalv1_ports_bond-port.md | 36 ++++ docs/equinix_metalv1_ports_convert-layer2.md | 37 ++++ docs/equinix_metalv1_ports_convert-layer3.md | 37 ++++ ...ports_create-port-vlan-assignment-batch.md | 37 ++++ ...quinix_metalv1_ports_delete-native-vlan.md | 35 ++++ docs/equinix_metalv1_ports_disbond-port.md | 36 ++++ docs/equinix_metalv1_ports_find-port-by-id.md | 35 ++++ ...ssignment-batch-by-port-id-and-batch-id.md | 36 ++++ ...ports_find-port-vlan-assignment-batches.md | 34 ++++ ...assignment-by-port-id-and-assignment-id.md | 36 ++++ ...etalv1_ports_find-port-vlan-assignments.md | 35 ++++ docs/equinix_metalv1_ports_unassign-port.md | 37 ++++ docs/equinix_metalv1_projects.md | 37 ++++ ...alv1_projects_create-project-invitation.md | 41 +++++ ...equinix_metalv1_projects_create-project.md | 42 +++++ ...etalv1_projects_create-transfer-request.md | 37 ++++ ...equinix_metalv1_projects_delete-project.md | 34 ++++ ...rojects_find-i-p-reservation-customdata.md | 35 ++++ ...nix_metalv1_projects_find-project-by-id.md | 36 ++++ ...etalv1_projects_find-project-customdata.md | 34 ++++ ...talv1_projects_find-project-invitations.md | 37 ++++ ...talv1_projects_find-project-memberships.md | 38 ++++ .../equinix_metalv1_projects_find-projects.md | 38 ++++ ...equinix_metalv1_projects_update-project.md | 42 +++++ 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 ++++ ...inix_metalv1_s-s-h-keys_find-s-s-h-keys.md | 38 ++++ ...nix_metalv1_s-s-h-keys_update-s-s-h-key.md | 42 +++++ ...uinix_metalv1_self-service-reservations.md | 29 ++++ ...vations_create-self-service-reservation.md | 40 +++++ ...ervations_find-self-service-reservation.md | 35 ++++ ...rvations_find-self-service-reservations.md | 37 ++++ docs/equinix_metalv1_spot-market.md | 33 ++++ ..._spot-market_create-spot-market-request.md | 59 +++++++ ..._spot-market_delete-spot-market-request.md | 35 ++++ ...ot-market_find-metro-spot-market-prices.md | 35 ++++ ...-market_find-spot-market-prices-history.md | 38 ++++ ...lv1_spot-market_find-spot-market-prices.md | 35 ++++ ...t-market_find-spot-market-request-by-id.md | 35 ++++ ...1_spot-market_list-spot-market-requests.md | 34 ++++ docs/equinix_metalv1_support-request.md | 27 +++ ...metalv1_support-request_request-support.md | 39 +++++ docs/equinix_metalv1_transfer-requests.md | 29 ++++ ...ansfer-requests_accept-transfer-request.md | 34 ++++ ...nsfer-requests_decline-transfer-request.md | 34 ++++ ...er-requests_find-transfer-request-by-id.md | 35 ++++ docs/equinix_metalv1_two-factor-auth.md | 28 +++ ...metalv1_two-factor-auth_disable-tfa-app.md | 34 ++++ ..._metalv1_two-factor-auth_enable-tfa-app.md | 34 ++++ docs/equinix_metalv1_usages.md | 28 +++ ...uinix_metalv1_usages_find-device-usages.md | 36 ++++ ...uinix_metalv1_usages_find-project-usage.md | 36 ++++ ...quinix_metalv1_user-verification-tokens.md | 28 +++ ...ion-tokens_consume-verification-request.md | 36 ++++ ...cation-tokens_create-validation-request.md | 35 ++++ docs/equinix_metalv1_userdata.md | 27 +++ ...inix_metalv1_userdata_validate-userdata.md | 34 ++++ docs/equinix_metalv1_users.md | 33 ++++ docs/equinix_metalv1_users_create-user.md | 51 ++++++ ...equinix_metalv1_users_find-current-user.md | 35 ++++ .../equinix_metalv1_users_find-invitations.md | 36 ++++ docs/equinix_metalv1_users_find-user-by-id.md | 36 ++++ ...inix_metalv1_users_find-user-customdata.md | 34 ++++ docs/equinix_metalv1_users_find-users.md | 37 ++++ ...uinix_metalv1_users_update-current-user.md | 42 +++++ docs/equinix_metalv1_v-l-a-ns.md | 31 ++++ ...metalv1_v-l-a-ns_create-virtual-network.md | 46 +++++ ...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 +++++ ...metalv1_v-l-a-ns_update-virtual-network.md | 42 +++++ docs/equinix_metalv1_v-r-fs.md | 42 +++++ ...lv1_v-r-fs_bgp-dynamic-neighbors-id-get.md | 39 +++++ ...equinix_metalv1_v-r-fs_create-vrf-route.md | 43 +++++ docs/equinix_metalv1_v-r-fs_create-vrf.md | 49 ++++++ ...-r-fs_delete-bgp-dynamic-neighbor-by-id.md | 39 +++++ ...x_metalv1_v-r-fs_delete-vrf-route-by-id.md | 39 +++++ docs/equinix_metalv1_v-r-fs_delete-vrf.md | 37 ++++ docs/equinix_metalv1_v-r-fs_find-vrf-by-id.md | 39 +++++ ..._metalv1_v-r-fs_find-vrf-ip-reservation.md | 40 +++++ ...metalv1_v-r-fs_find-vrf-ip-reservations.md | 39 +++++ ...nix_metalv1_v-r-fs_find-vrf-route-by-id.md | 39 +++++ docs/equinix_metalv1_v-r-fs_find-vrfs.md | 40 +++++ ..._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_v-r-fs_get-vrf-routes.md | 39 +++++ ...x_metalv1_v-r-fs_update-vrf-route-by-id.md | 43 +++++ docs/equinix_metalv1_v-r-fs_update-vrf.md | 48 ++++++ docs/equinix_orderhistoryv1.md | 30 ++++ .../equinix_orderhistoryv1_retrieve-orders.md | 28 +++ ...-orders_g-e-t-retrieve-orders-locations.md | 34 ++++ ..._retrieve-orders_p-o-s-t-orders-history.md | 48 ++++++ docs/equinix_ordersv2.md | 30 ++++ docs/equinix_ordersv2_orders.md | 31 ++++ ...x_ordersv2_orders_add-notes-to-an-order.md | 38 ++++ ...equinix_ordersv2_orders_cancel-an-order.md | 38 ++++ ...nix_ordersv2_orders_g-e-t-order-details.md | 35 ++++ ...v2_orders_reply-to-an-order-negotiation.md | 38 ++++ ...rsv2_orders_retrieve-order-negotiations.md | 34 ++++ docs/equinix_securecabinetv1.md | 31 ++++ docs/equinix_securecabinetv1_availability.md | 27 +++ ..._availability_get-products-availability.md | 34 ++++ docs/equinix_securecabinetv1_orders.md | 27 +++ ...nix_securecabinetv1_orders_create-order.md | 51 ++++++ docs/equinix_smarthandsv1.md | 30 ++++ docs/equinix_smarthandsv1_smarthands.md | 40 +++++ ...ix_smarthandsv1_smarthands_get-location.md | 37 ++++ ...s_handle-smart-hand-cable-request-order.md | 54 ++++++ ...ds_handle-smart-hand-cage-cleanup-order.md | 52 ++++++ ...nds_handle-smart-hand-cage-escort-order.md | 54 ++++++ ..._handle-smart-hand-locate-package-order.md | 54 ++++++ ...ndle-smart-hand-move-jumper-cable-order.md | 54 ++++++ ...dsv1_smarthands_handle-smart-hand-order.md | 59 +++++++ ...arthands_handle-smart-hand-others-order.md | 50 ++++++ ...le-smart-hand-patch-cable-install-order.md | 50 ++++++ ...le-smart-hand-patch-cable-removal-order.md | 50 ++++++ ...ndle-smart-hand-pictures-document-order.md | 54 ++++++ ...andle-smart-hand-run-jumper-cable-order.md | 57 ++++++ ...handle-smart-hand-shipment-unpack-order.md | 53 ++++++ ...marthandsv1_smarthands_smart-hand-types.md | 34 ++++ docs/equinix_stsv1alpha.md | 30 ++++ docs/equinix_stsv1alpha_use.md | 27 +++ docs/equinix_stsv1alpha_use_use-token-post.md | 37 ++++ 489 files changed, 18578 insertions(+) create mode 100644 docs/equinix_accesstokenv1.md create mode 100644 docs/equinix_accesstokenv1_o-auth2-token.md create mode 100644 docs/equinix_accesstokenv1_o-auth2-token_get-o-auth2-access-token.md create mode 100644 docs/equinix_accesstokenv1_o-auth2-token_refresh-o-auth2-access-token.md create mode 100644 docs/equinix_eiav2.md create mode 100644 docs/equinix_eiav2_e-i-a-service.md create mode 100644 docs/equinix_eiav2_e-i-a-service_create-equinix-internet-accessv2.md create mode 100644 docs/equinix_fabricv4.md create mode 100644 docs/equinix_fabricv4_cloud-events.md create mode 100644 docs/equinix_fabricv4_cloud-events_get-cloud-event-by-asset-id.md create mode 100644 docs/equinix_fabricv4_cloud-events_get-cloud-event.md create mode 100644 docs/equinix_fabricv4_cloud-events_search-cloud-events.md create mode 100644 docs/equinix_fabricv4_cloud-routers.md create mode 100644 docs/equinix_fabricv4_cloud-routers_create-cloud-router-action.md create mode 100644 docs/equinix_fabricv4_cloud-routers_create-cloud-router-command.md create mode 100644 docs/equinix_fabricv4_cloud-routers_create-cloud-router.md create mode 100644 docs/equinix_fabricv4_cloud-routers_delete-cloud-router-by-uuid.md create mode 100644 docs/equinix_fabricv4_cloud-routers_delete-cloud-router-command-by-uuid.md create mode 100644 docs/equinix_fabricv4_cloud-routers_get-all-cloud-router-commands.md create mode 100644 docs/equinix_fabricv4_cloud-routers_get-cloud-router-actions-by-uuid.md create mode 100644 docs/equinix_fabricv4_cloud-routers_get-cloud-router-actions.md create mode 100644 docs/equinix_fabricv4_cloud-routers_get-cloud-router-by-uuid.md create mode 100644 docs/equinix_fabricv4_cloud-routers_get-cloud-router-command.md create mode 100644 docs/equinix_fabricv4_cloud-routers_get-cloud-router-package-by-code.md create mode 100644 docs/equinix_fabricv4_cloud-routers_get-cloud-router-packages.md create mode 100644 docs/equinix_fabricv4_cloud-routers_get-gateway-attachment-to-cloud-router-by-uuid.md create mode 100644 docs/equinix_fabricv4_cloud-routers_list-gateway-attachments-to-cloud-router.md create mode 100644 docs/equinix_fabricv4_cloud-routers_search-cloud-router-commands.md create mode 100644 docs/equinix_fabricv4_cloud-routers_search-cloud-router-routes.md create mode 100644 docs/equinix_fabricv4_cloud-routers_search-cloud-routers.md create mode 100644 docs/equinix_fabricv4_cloud-routers_search-connection-advertised-routes.md create mode 100644 docs/equinix_fabricv4_cloud-routers_search-connection-received-routes.md create mode 100644 docs/equinix_fabricv4_cloud-routers_search-router-actions.md create mode 100644 docs/equinix_fabricv4_cloud-routers_update-cloud-router-by-uuid.md create mode 100644 docs/equinix_fabricv4_connections.md create mode 100644 docs/equinix_fabricv4_connections_create-connection-action.md create mode 100644 docs/equinix_fabricv4_connections_create-connection.md create mode 100644 docs/equinix_fabricv4_connections_delete-connection-by-uuid.md create mode 100644 docs/equinix_fabricv4_connections_get-connection-by-uuid.md create mode 100644 docs/equinix_fabricv4_connections_search-connections.md create mode 100644 docs/equinix_fabricv4_connections_update-connection-by-uuid.md create mode 100644 docs/equinix_fabricv4_connections_validate-connections.md create mode 100644 docs/equinix_fabricv4_health.md create mode 100644 docs/equinix_fabricv4_health_get-status.md create mode 100644 docs/equinix_fabricv4_marketplace-subscriptions.md create mode 100644 docs/equinix_fabricv4_marketplace-subscriptions_get-subscription-by-id.md create mode 100644 docs/equinix_fabricv4_metrics.md create mode 100644 docs/equinix_fabricv4_metrics_get-metric-by-asset-id.md create mode 100644 docs/equinix_fabricv4_metrics_search-metrics.md create mode 100644 docs/equinix_fabricv4_metros.md create mode 100644 docs/equinix_fabricv4_metros_get-metro-by-code.md create mode 100644 docs/equinix_fabricv4_metros_get-metros.md create mode 100644 docs/equinix_fabricv4_networks.md create mode 100644 docs/equinix_fabricv4_networks_create-network.md create mode 100644 docs/equinix_fabricv4_networks_delete-network-by-uuid.md create mode 100644 docs/equinix_fabricv4_networks_get-connections-by-network-uuid.md create mode 100644 docs/equinix_fabricv4_networks_get-network-by-uuid.md create mode 100644 docs/equinix_fabricv4_networks_get-network-change-by-uuid.md create mode 100644 docs/equinix_fabricv4_networks_get-network-changes.md create mode 100644 docs/equinix_fabricv4_networks_search-networks.md create mode 100644 docs/equinix_fabricv4_networks_update-network-by-uuid.md create mode 100644 docs/equinix_fabricv4_port-packages.md create mode 100644 docs/equinix_fabricv4_port-packages_get-port-packages.md create mode 100644 docs/equinix_fabricv4_ports.md create mode 100644 docs/equinix_fabricv4_ports_add-to-lag.md create mode 100644 docs/equinix_fabricv4_ports_create-port.md create mode 100644 docs/equinix_fabricv4_ports_delete-port.md create mode 100644 docs/equinix_fabricv4_ports_get-port-by-uuid.md create mode 100644 docs/equinix_fabricv4_ports_get-ports.md create mode 100644 docs/equinix_fabricv4_ports_get-vlans.md create mode 100644 docs/equinix_fabricv4_ports_search-ports.md create mode 100644 docs/equinix_fabricv4_ports_update-port-by-uuid.md create mode 100644 docs/equinix_fabricv4_precision-time.md create mode 100644 docs/equinix_fabricv4_precision-time_create-time-services.md create mode 100644 docs/equinix_fabricv4_precision-time_delete-time-service-by-id.md create mode 100644 docs/equinix_fabricv4_precision-time_fulfill-time-services.md create mode 100644 docs/equinix_fabricv4_precision-time_get-time-services-by-id.md create mode 100644 docs/equinix_fabricv4_precision-time_get-time-services-connections-by-service-id.md create mode 100644 docs/equinix_fabricv4_precision-time_get-time-services-package-by-code.md create mode 100644 docs/equinix_fabricv4_precision-time_get-time-services-packages.md create mode 100644 docs/equinix_fabricv4_precision-time_search-time-services.md create mode 100644 docs/equinix_fabricv4_precision-time_update-time-services-by-id.md create mode 100644 docs/equinix_fabricv4_prices.md create mode 100644 docs/equinix_fabricv4_prices_search-prices.md create mode 100644 docs/equinix_fabricv4_route-aggregation-rules.md create mode 100644 docs/equinix_fabricv4_route-aggregation-rules_create-route-aggregation-rule.md create mode 100644 docs/equinix_fabricv4_route-aggregation-rules_create-route-aggregation-rules-in-bulk.md create mode 100644 docs/equinix_fabricv4_route-aggregation-rules_delete-route-aggregation-rule-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-change-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-changes.md create mode 100644 docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rules.md create mode 100644 docs/equinix_fabricv4_route-aggregation-rules_patch-route-aggregation-rule-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-aggregation-rules_replace-route-aggregation-rule-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-aggregations.md create mode 100644 docs/equinix_fabricv4_route-aggregations_attach-connection-route-aggregation.md create mode 100644 docs/equinix_fabricv4_route-aggregations_create-route-aggregation.md create mode 100644 docs/equinix_fabricv4_route-aggregations_delete-route-aggregation-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-aggregations_detach-connection-route-aggregation.md create mode 100644 docs/equinix_fabricv4_route-aggregations_get-connection-route-aggregation-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-aggregations_get-connection-route-aggregations.md create mode 100644 docs/equinix_fabricv4_route-aggregations_get-route-aggregation-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-aggregations_get-route-aggregation-change-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-aggregations_get-route-aggregation-changes.md create mode 100644 docs/equinix_fabricv4_route-aggregations_get-route-aggregation-connections.md create mode 100644 docs/equinix_fabricv4_route-aggregations_patch-route-aggregation-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-aggregations_search-route-aggregations.md create mode 100644 docs/equinix_fabricv4_route-filter-rules.md create mode 100644 docs/equinix_fabricv4_route-filter-rules_create-route-filter-rule.md create mode 100644 docs/equinix_fabricv4_route-filter-rules_create-route-filter-rules-in-bulk.md create mode 100644 docs/equinix_fabricv4_route-filter-rules_delete-route-filter-rule-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-change-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-changes.md create mode 100644 docs/equinix_fabricv4_route-filter-rules_get-route-filter-rules.md create mode 100644 docs/equinix_fabricv4_route-filter-rules_patch-route-filter-rule-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-filter-rules_replace-route-filter-rule-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-filters.md create mode 100644 docs/equinix_fabricv4_route-filters_attach-connection-route-filter.md create mode 100644 docs/equinix_fabricv4_route-filters_create-route-filter.md create mode 100644 docs/equinix_fabricv4_route-filters_delete-route-filter-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-filters_detach-connection-route-filter.md create mode 100644 docs/equinix_fabricv4_route-filters_get-connection-route-filter-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-filters_get-connection-route-filters.md create mode 100644 docs/equinix_fabricv4_route-filters_get-route-filter-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-filters_get-route-filter-change-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-filters_get-route-filter-changes.md create mode 100644 docs/equinix_fabricv4_route-filters_get-route-filter-connections.md create mode 100644 docs/equinix_fabricv4_route-filters_patch-route-filter-by-uuid.md create mode 100644 docs/equinix_fabricv4_route-filters_search-route-filters.md create mode 100644 docs/equinix_fabricv4_routing-protocols.md create mode 100644 docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocol.md create mode 100644 docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocols-in-bulk.md create mode 100644 docs/equinix_fabricv4_routing-protocols_delete-connection-routing-protocol-by-uuid.md create mode 100644 docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocol-all-bgp-actions.md create mode 100644 docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocol-by-uuid.md create mode 100644 docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-bgp-action-by-uuid.md create mode 100644 docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-change-by-uuid.md create mode 100644 docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-changes.md create mode 100644 docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols.md create mode 100644 docs/equinix_fabricv4_routing-protocols_patch-connection-routing-protocol-by-uuid.md create mode 100644 docs/equinix_fabricv4_routing-protocols_post-connection-routing-protocol-bgp-action-by-uuid.md create mode 100644 docs/equinix_fabricv4_routing-protocols_replace-connection-routing-protocol-by-uuid.md create mode 100644 docs/equinix_fabricv4_routing-protocols_validate-routing-protocol.md create mode 100644 docs/equinix_fabricv4_service-profiles.md create mode 100644 docs/equinix_fabricv4_service-profiles_create-service-profile.md create mode 100644 docs/equinix_fabricv4_service-profiles_delete-service-profile-by-uuid.md create mode 100644 docs/equinix_fabricv4_service-profiles_get-service-profile-by-uuid.md create mode 100644 docs/equinix_fabricv4_service-profiles_get-service-profile-metros-by-uuid.md create mode 100644 docs/equinix_fabricv4_service-profiles_get-service-profiles.md create mode 100644 docs/equinix_fabricv4_service-profiles_put-service-profile-by-uuid.md create mode 100644 docs/equinix_fabricv4_service-profiles_search-service-profiles.md create mode 100644 docs/equinix_fabricv4_service-profiles_update-service-profile-by-uuid.md create mode 100644 docs/equinix_fabricv4_service-tokens.md create mode 100644 docs/equinix_fabricv4_service-tokens_create-service-token-action.md create mode 100644 docs/equinix_fabricv4_service-tokens_create-service-token.md create mode 100644 docs/equinix_fabricv4_service-tokens_delete-service-token-by-uuid.md create mode 100644 docs/equinix_fabricv4_service-tokens_get-service-token-by-uuid.md create mode 100644 docs/equinix_fabricv4_service-tokens_get-service-tokens.md create mode 100644 docs/equinix_fabricv4_service-tokens_search-service-tokens.md create mode 100644 docs/equinix_fabricv4_service-tokens_update-service-token-by-uuid.md create mode 100644 docs/equinix_fabricv4_statistics.md create mode 100644 docs/equinix_fabricv4_statistics_get-connection-stats-by-port-uuid.md create mode 100644 docs/equinix_fabricv4_statistics_get-port-stats-by-port-uuid.md create mode 100644 docs/equinix_fabricv4_stream-alert-rules.md create mode 100644 docs/equinix_fabricv4_stream-alert-rules_create-stream-alert-rules.md create mode 100644 docs/equinix_fabricv4_stream-alert-rules_delete-stream-alert-rule-by-uuid.md create mode 100644 docs/equinix_fabricv4_stream-alert-rules_get-stream-alert-rule-by-uuid.md create mode 100644 docs/equinix_fabricv4_stream-alert-rules_get-stream-alert-rules.md create mode 100644 docs/equinix_fabricv4_stream-alert-rules_update-stream-alert-rule-by-uuid.md create mode 100644 docs/equinix_fabricv4_stream-subscriptions.md create mode 100644 docs/equinix_fabricv4_stream-subscriptions_create-stream-subscriptions.md create mode 100644 docs/equinix_fabricv4_stream-subscriptions_delete-stream-subscription-by-uuid.md create mode 100644 docs/equinix_fabricv4_stream-subscriptions_get-stream-subscription-by-uuid.md create mode 100644 docs/equinix_fabricv4_stream-subscriptions_get-stream-subscriptions.md create mode 100644 docs/equinix_fabricv4_stream-subscriptions_update-stream-subscription-by-uuid.md create mode 100644 docs/equinix_fabricv4_streams.md create mode 100644 docs/equinix_fabricv4_streams_create-streams.md create mode 100644 docs/equinix_fabricv4_streams_delete-stream-asset-by-uuid.md create mode 100644 docs/equinix_fabricv4_streams_delete-stream-by-uuid.md create mode 100644 docs/equinix_fabricv4_streams_get-stream-asset-by-uuid.md create mode 100644 docs/equinix_fabricv4_streams_get-stream-by-uuid.md create mode 100644 docs/equinix_fabricv4_streams_get-streams-assets.md create mode 100644 docs/equinix_fabricv4_streams_get-streams.md create mode 100644 docs/equinix_fabricv4_streams_update-stream-asset-by-uuid.md create mode 100644 docs/equinix_fabricv4_streams_update-stream-by-uuid.md create mode 100644 docs/equinix_lookupv2.md create mode 100644 docs/equinix_lookupv2_lookup.md create mode 100644 docs/equinix_lookupv2_lookup_get-locations-by-permission-code.md create mode 100644 docs/equinix_lookupv2_lookup_retrieve-all-patch-panels.md create mode 100644 docs/equinix_lookupv2_lookup_retrieve-list-of-connection-services.md create mode 100644 docs/equinix_lookupv2_lookup_retrieve-list-of-providers.md create mode 100644 docs/equinix_lookupv2_lookup_retrieve-patch-panel-details.md create mode 100644 docs/equinix_metalv1.md create mode 100644 docs/equinix_metalv1_authentication.md create mode 100644 docs/equinix_metalv1_authentication_create-a-p-i-key.md create mode 100644 docs/equinix_metalv1_authentication_create-project-a-p-i-key.md create mode 100644 docs/equinix_metalv1_authentication_delete-a-p-i-key.md create mode 100644 docs/equinix_metalv1_authentication_delete-user-a-p-i-key.md create mode 100644 docs/equinix_metalv1_authentication_find-a-p-i-keys.md create mode 100644 docs/equinix_metalv1_authentication_find-project-a-p-i-keys.md create mode 100644 docs/equinix_metalv1_b-g-p.md create mode 100644 docs/equinix_metalv1_b-g-p_delete-bgp-session.md create mode 100644 docs/equinix_metalv1_b-g-p_find-bgp-config-by-project.md create mode 100644 docs/equinix_metalv1_b-g-p_find-bgp-session-by-id.md create mode 100644 docs/equinix_metalv1_b-g-p_find-global-bgp-ranges.md create mode 100644 docs/equinix_metalv1_b-g-p_find-project-bgp-sessions.md create mode 100644 docs/equinix_metalv1_b-g-p_request-bgp-config.md create mode 100644 docs/equinix_metalv1_b-g-p_update-bgp-session.md create mode 100644 docs/equinix_metalv1_batches.md create mode 100644 docs/equinix_metalv1_batches_create-device-batch.md create mode 100644 docs/equinix_metalv1_batches_delete-batch.md create mode 100644 docs/equinix_metalv1_batches_find-batch-by-id.md create mode 100644 docs/equinix_metalv1_batches_find-batches-by-project.md create mode 100644 docs/equinix_metalv1_capacity.md create mode 100644 docs/equinix_metalv1_capacity_check-capacity-for-facility.md create mode 100644 docs/equinix_metalv1_capacity_check-capacity-for-metro.md create mode 100644 docs/equinix_metalv1_capacity_find-capacity-for-facility.md create mode 100644 docs/equinix_metalv1_capacity_find-capacity-for-metro.md create mode 100644 docs/equinix_metalv1_capacity_find-organization-capacity-per-facility.md create mode 100644 docs/equinix_metalv1_capacity_find-organization-capacity-per-metro.md create mode 100644 docs/equinix_metalv1_console-log-details.md create mode 100644 docs/equinix_metalv1_console-log-details_capture-screenshot.md create mode 100644 docs/equinix_metalv1_devices.md create mode 100644 docs/equinix_metalv1_devices_create-bgp-session.md create mode 100644 docs/equinix_metalv1_devices_create-device.md create mode 100644 docs/equinix_metalv1_devices_create-i-p-assignment.md create mode 100644 docs/equinix_metalv1_devices_delete-device.md create mode 100644 docs/equinix_metalv1_devices_find-bgp-sessions.md create mode 100644 docs/equinix_metalv1_devices_find-device-by-id.md create mode 100644 docs/equinix_metalv1_devices_find-device-customdata.md create mode 100644 docs/equinix_metalv1_devices_find-device-metadata-by-i-d.md create mode 100644 docs/equinix_metalv1_devices_find-device-userdata-by-i-d.md create mode 100644 docs/equinix_metalv1_devices_find-i-p-assignment-customdata.md create mode 100644 docs/equinix_metalv1_devices_find-i-p-assignments.md create mode 100644 docs/equinix_metalv1_devices_find-instance-bandwidth.md create mode 100644 docs/equinix_metalv1_devices_find-organization-devices.md create mode 100644 docs/equinix_metalv1_devices_find-project-devices.md create mode 100644 docs/equinix_metalv1_devices_find-traffic.md create mode 100644 docs/equinix_metalv1_devices_get-bgp-neighbor-data.md create mode 100644 docs/equinix_metalv1_devices_get-device-firmware-sets.md create mode 100644 docs/equinix_metalv1_devices_get-device-health-rollup.md create mode 100644 docs/equinix_metalv1_devices_perform-action.md create mode 100644 docs/equinix_metalv1_devices_update-device.md create mode 100644 docs/equinix_metalv1_emails.md create mode 100644 docs/equinix_metalv1_emails_create-email.md create mode 100644 docs/equinix_metalv1_emails_delete-email.md create mode 100644 docs/equinix_metalv1_emails_find-email-by-id.md create mode 100644 docs/equinix_metalv1_emails_update-email.md create mode 100644 docs/equinix_metalv1_events.md create mode 100644 docs/equinix_metalv1_events_find-device-events.md create mode 100644 docs/equinix_metalv1_events_find-event-by-id.md create mode 100644 docs/equinix_metalv1_events_find-events.md create mode 100644 docs/equinix_metalv1_events_find-interconnection-events.md create mode 100644 docs/equinix_metalv1_events_find-interconnection-port-events.md create mode 100644 docs/equinix_metalv1_events_find-organization-events.md create mode 100644 docs/equinix_metalv1_events_find-project-events.md create mode 100644 docs/equinix_metalv1_events_find-virtual-circuit-events.md create mode 100644 docs/equinix_metalv1_events_find-vrf-route-events.md create mode 100644 docs/equinix_metalv1_facilities.md create mode 100644 docs/equinix_metalv1_facilities_find-facilities-by-organization.md create mode 100644 docs/equinix_metalv1_facilities_find-facilities-by-project.md create mode 100644 docs/equinix_metalv1_facilities_find-facilities.md create mode 100644 docs/equinix_metalv1_firmware-sets.md create mode 100644 docs/equinix_metalv1_firmware-sets_get-organization-firmware-sets.md create mode 100644 docs/equinix_metalv1_firmware-sets_get-project-firmware-sets.md create mode 100644 docs/equinix_metalv1_hardware-reservations.md create mode 100644 docs/equinix_metalv1_hardware-reservations_activate-hardware-reservation.md create mode 100644 docs/equinix_metalv1_hardware-reservations_find-hardware-reservation-by-id.md create mode 100644 docs/equinix_metalv1_hardware-reservations_find-project-hardware-reservations.md create mode 100644 docs/equinix_metalv1_hardware-reservations_move-hardware-reservation.md create mode 100644 docs/equinix_metalv1_i-p-addresses.md create mode 100644 docs/equinix_metalv1_i-p-addresses_delete-i-p-address.md create mode 100644 docs/equinix_metalv1_i-p-addresses_find-i-p-address-by-id.md create mode 100644 docs/equinix_metalv1_i-p-addresses_find-i-p-address-customdata.md create mode 100644 docs/equinix_metalv1_i-p-addresses_find-i-p-availabilities.md create mode 100644 docs/equinix_metalv1_i-p-addresses_find-i-p-reservations.md create mode 100644 docs/equinix_metalv1_i-p-addresses_request-i-p-reservation.md create mode 100644 docs/equinix_metalv1_i-p-addresses_update-i-p-address.md create mode 100644 docs/equinix_metalv1_incidents.md create mode 100644 docs/equinix_metalv1_incidents_find-incidents.md create mode 100644 docs/equinix_metalv1_interconnections.md create mode 100644 docs/equinix_metalv1_interconnections_create-interconnection-port-virtual-circuit.md create mode 100644 docs/equinix_metalv1_interconnections_create-organization-interconnection.md create mode 100644 docs/equinix_metalv1_interconnections_create-project-interconnection.md create mode 100644 docs/equinix_metalv1_interconnections_delete-interconnection.md create mode 100644 docs/equinix_metalv1_interconnections_delete-virtual-circuit.md create mode 100644 docs/equinix_metalv1_interconnections_get-interconnection-metros.md create mode 100644 docs/equinix_metalv1_interconnections_get-interconnection-port.md create mode 100644 docs/equinix_metalv1_interconnections_get-interconnection-pricing.md create mode 100644 docs/equinix_metalv1_interconnections_get-interconnection.md create mode 100644 docs/equinix_metalv1_interconnections_get-virtual-circuit.md create mode 100644 docs/equinix_metalv1_interconnections_list-interconnection-port-virtual-circuits.md create mode 100644 docs/equinix_metalv1_interconnections_list-interconnection-ports.md create mode 100644 docs/equinix_metalv1_interconnections_list-interconnection-virtual-circuits.md create mode 100644 docs/equinix_metalv1_interconnections_organization-list-interconnections.md create mode 100644 docs/equinix_metalv1_interconnections_project-list-interconnections.md create mode 100644 docs/equinix_metalv1_interconnections_update-interconnection.md create mode 100644 docs/equinix_metalv1_interconnections_update-virtual-circuit.md create mode 100644 docs/equinix_metalv1_invitations.md create mode 100644 docs/equinix_metalv1_invitations_accept-invitation.md create mode 100644 docs/equinix_metalv1_invitations_decline-invitation.md create mode 100644 docs/equinix_metalv1_invitations_find-invitation-by-id.md create mode 100644 docs/equinix_metalv1_invoices.md create mode 100644 docs/equinix_metalv1_invoices_find-organization-invoices.md create mode 100644 docs/equinix_metalv1_invoices_get-invoice-by-id.md create mode 100644 docs/equinix_metalv1_licenses.md create mode 100644 docs/equinix_metalv1_licenses_create-license.md create mode 100644 docs/equinix_metalv1_licenses_delete-license.md create mode 100644 docs/equinix_metalv1_licenses_find-license-by-id.md create mode 100644 docs/equinix_metalv1_licenses_find-project-licenses.md create mode 100644 docs/equinix_metalv1_licenses_update-license.md create mode 100644 docs/equinix_metalv1_memberships.md create mode 100644 docs/equinix_metalv1_memberships_delete-membership.md create mode 100644 docs/equinix_metalv1_memberships_find-membership-by-id.md create mode 100644 docs/equinix_metalv1_memberships_update-membership.md create mode 100644 docs/equinix_metalv1_metal-gateways.md create mode 100644 docs/equinix_metalv1_metal-gateways_create-bgp-dynamic-neighbor.md create mode 100644 docs/equinix_metalv1_metal-gateways_create-metal-gateway-elastic-ip.md create mode 100644 docs/equinix_metalv1_metal-gateways_create-metal-gateway.md create mode 100644 docs/equinix_metalv1_metal-gateways_delete-metal-gateway.md create mode 100644 docs/equinix_metalv1_metal-gateways_find-metal-gateway-by-id.md create mode 100644 docs/equinix_metalv1_metal-gateways_find-metal-gateways-by-project.md create mode 100644 docs/equinix_metalv1_metal-gateways_get-bgp-dynamic-neighbors.md create mode 100644 docs/equinix_metalv1_metal-gateways_get-metal-gateway-elastic-ips.md create mode 100644 docs/equinix_metalv1_metros.md create mode 100644 docs/equinix_metalv1_metros_find-metros.md create mode 100644 docs/equinix_metalv1_metros_get-metro.md create mode 100644 docs/equinix_metalv1_operating-systems.md create mode 100644 docs/equinix_metalv1_operating-systems_find-operating-system-version.md create mode 100644 docs/equinix_metalv1_operating-systems_find-operating-systems.md create mode 100644 docs/equinix_metalv1_organizations.md create mode 100644 docs/equinix_metalv1_organizations_create-organization-invitation.md create mode 100644 docs/equinix_metalv1_organizations_create-organization-project.md create mode 100644 docs/equinix_metalv1_organizations_create-organization.md create mode 100644 docs/equinix_metalv1_organizations_create-payment-method.md create mode 100644 docs/equinix_metalv1_organizations_delete-organization.md create mode 100644 docs/equinix_metalv1_organizations_find-operating-systems-by-organization.md create mode 100644 docs/equinix_metalv1_organizations_find-organization-by-id.md create mode 100644 docs/equinix_metalv1_organizations_find-organization-customdata.md create mode 100644 docs/equinix_metalv1_organizations_find-organization-invitations.md create mode 100644 docs/equinix_metalv1_organizations_find-organization-payment-methods.md create mode 100644 docs/equinix_metalv1_organizations_find-organization-projects.md create mode 100644 docs/equinix_metalv1_organizations_find-organization-transfers.md create mode 100644 docs/equinix_metalv1_organizations_find-organizations.md create mode 100644 docs/equinix_metalv1_organizations_find-plans-by-organization.md create mode 100644 docs/equinix_metalv1_organizations_update-organization.md create mode 100644 docs/equinix_metalv1_password-reset-tokens.md create mode 100644 docs/equinix_metalv1_password-reset-tokens_create-password-reset-token.md create mode 100644 docs/equinix_metalv1_password-reset-tokens_reset-password.md create mode 100644 docs/equinix_metalv1_payment-methods.md create mode 100644 docs/equinix_metalv1_payment-methods_delete-payment-method.md create mode 100644 docs/equinix_metalv1_payment-methods_find-payment-method-by-id.md create mode 100644 docs/equinix_metalv1_payment-methods_update-payment-method.md create mode 100644 docs/equinix_metalv1_plans.md create mode 100644 docs/equinix_metalv1_plans_find-plans-by-project.md create mode 100644 docs/equinix_metalv1_plans_find-plans.md create mode 100644 docs/equinix_metalv1_ports.md create mode 100644 docs/equinix_metalv1_ports_assign-native-vlan.md create mode 100644 docs/equinix_metalv1_ports_assign-port.md create mode 100644 docs/equinix_metalv1_ports_bond-port.md create mode 100644 docs/equinix_metalv1_ports_convert-layer2.md create mode 100644 docs/equinix_metalv1_ports_convert-layer3.md create mode 100644 docs/equinix_metalv1_ports_create-port-vlan-assignment-batch.md create mode 100644 docs/equinix_metalv1_ports_delete-native-vlan.md create mode 100644 docs/equinix_metalv1_ports_disbond-port.md create mode 100644 docs/equinix_metalv1_ports_find-port-by-id.md create mode 100644 docs/equinix_metalv1_ports_find-port-vlan-assignment-batch-by-port-id-and-batch-id.md create mode 100644 docs/equinix_metalv1_ports_find-port-vlan-assignment-batches.md create mode 100644 docs/equinix_metalv1_ports_find-port-vlan-assignment-by-port-id-and-assignment-id.md create mode 100644 docs/equinix_metalv1_ports_find-port-vlan-assignments.md create mode 100644 docs/equinix_metalv1_ports_unassign-port.md create mode 100644 docs/equinix_metalv1_projects.md create mode 100644 docs/equinix_metalv1_projects_create-project-invitation.md create mode 100644 docs/equinix_metalv1_projects_create-project.md create mode 100644 docs/equinix_metalv1_projects_create-transfer-request.md create mode 100644 docs/equinix_metalv1_projects_delete-project.md create mode 100644 docs/equinix_metalv1_projects_find-i-p-reservation-customdata.md create mode 100644 docs/equinix_metalv1_projects_find-project-by-id.md create mode 100644 docs/equinix_metalv1_projects_find-project-customdata.md create mode 100644 docs/equinix_metalv1_projects_find-project-invitations.md create mode 100644 docs/equinix_metalv1_projects_find-project-memberships.md create mode 100644 docs/equinix_metalv1_projects_find-projects.md create mode 100644 docs/equinix_metalv1_projects_update-project.md create mode 100644 docs/equinix_metalv1_s-s-h-keys.md create mode 100644 docs/equinix_metalv1_s-s-h-keys_create-project-s-s-h-key.md create mode 100644 docs/equinix_metalv1_s-s-h-keys_create-s-s-h-key.md create mode 100644 docs/equinix_metalv1_s-s-h-keys_delete-s-s-h-key.md create mode 100644 docs/equinix_metalv1_s-s-h-keys_find-device-s-s-h-keys.md create mode 100644 docs/equinix_metalv1_s-s-h-keys_find-project-s-s-h-keys.md create mode 100644 docs/equinix_metalv1_s-s-h-keys_find-s-s-h-key-by-id.md create mode 100644 docs/equinix_metalv1_s-s-h-keys_find-s-s-h-keys.md create mode 100644 docs/equinix_metalv1_s-s-h-keys_update-s-s-h-key.md create mode 100644 docs/equinix_metalv1_self-service-reservations.md create mode 100644 docs/equinix_metalv1_self-service-reservations_create-self-service-reservation.md create mode 100644 docs/equinix_metalv1_self-service-reservations_find-self-service-reservation.md create mode 100644 docs/equinix_metalv1_self-service-reservations_find-self-service-reservations.md create mode 100644 docs/equinix_metalv1_spot-market.md create mode 100644 docs/equinix_metalv1_spot-market_create-spot-market-request.md create mode 100644 docs/equinix_metalv1_spot-market_delete-spot-market-request.md create mode 100644 docs/equinix_metalv1_spot-market_find-metro-spot-market-prices.md create mode 100644 docs/equinix_metalv1_spot-market_find-spot-market-prices-history.md create mode 100644 docs/equinix_metalv1_spot-market_find-spot-market-prices.md create mode 100644 docs/equinix_metalv1_spot-market_find-spot-market-request-by-id.md create mode 100644 docs/equinix_metalv1_spot-market_list-spot-market-requests.md create mode 100644 docs/equinix_metalv1_support-request.md create mode 100644 docs/equinix_metalv1_support-request_request-support.md create mode 100644 docs/equinix_metalv1_transfer-requests.md create mode 100644 docs/equinix_metalv1_transfer-requests_accept-transfer-request.md create mode 100644 docs/equinix_metalv1_transfer-requests_decline-transfer-request.md create mode 100644 docs/equinix_metalv1_transfer-requests_find-transfer-request-by-id.md create mode 100644 docs/equinix_metalv1_two-factor-auth.md create mode 100644 docs/equinix_metalv1_two-factor-auth_disable-tfa-app.md create mode 100644 docs/equinix_metalv1_two-factor-auth_enable-tfa-app.md create mode 100644 docs/equinix_metalv1_usages.md create mode 100644 docs/equinix_metalv1_usages_find-device-usages.md create mode 100644 docs/equinix_metalv1_usages_find-project-usage.md create mode 100644 docs/equinix_metalv1_user-verification-tokens.md create mode 100644 docs/equinix_metalv1_user-verification-tokens_consume-verification-request.md create mode 100644 docs/equinix_metalv1_user-verification-tokens_create-validation-request.md create mode 100644 docs/equinix_metalv1_userdata.md create mode 100644 docs/equinix_metalv1_userdata_validate-userdata.md create mode 100644 docs/equinix_metalv1_users.md create mode 100644 docs/equinix_metalv1_users_create-user.md create mode 100644 docs/equinix_metalv1_users_find-current-user.md create mode 100644 docs/equinix_metalv1_users_find-invitations.md create mode 100644 docs/equinix_metalv1_users_find-user-by-id.md create mode 100644 docs/equinix_metalv1_users_find-user-customdata.md create mode 100644 docs/equinix_metalv1_users_find-users.md create mode 100644 docs/equinix_metalv1_users_update-current-user.md create mode 100644 docs/equinix_metalv1_v-l-a-ns.md create mode 100644 docs/equinix_metalv1_v-l-a-ns_create-virtual-network.md create mode 100644 docs/equinix_metalv1_v-l-a-ns_delete-virtual-network.md create mode 100644 docs/equinix_metalv1_v-l-a-ns_find-virtual-networks.md create mode 100644 docs/equinix_metalv1_v-l-a-ns_get-virtual-network.md create mode 100644 docs/equinix_metalv1_v-l-a-ns_update-virtual-network.md create mode 100644 docs/equinix_metalv1_v-r-fs.md create mode 100644 docs/equinix_metalv1_v-r-fs_bgp-dynamic-neighbors-id-get.md create mode 100644 docs/equinix_metalv1_v-r-fs_create-vrf-route.md create mode 100644 docs/equinix_metalv1_v-r-fs_create-vrf.md create mode 100644 docs/equinix_metalv1_v-r-fs_delete-bgp-dynamic-neighbor-by-id.md create mode 100644 docs/equinix_metalv1_v-r-fs_delete-vrf-route-by-id.md create mode 100644 docs/equinix_metalv1_v-r-fs_delete-vrf.md create mode 100644 docs/equinix_metalv1_v-r-fs_find-vrf-by-id.md create mode 100644 docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservation.md create mode 100644 docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservations.md create mode 100644 docs/equinix_metalv1_v-r-fs_find-vrf-route-by-id.md create mode 100644 docs/equinix_metalv1_v-r-fs_find-vrfs.md create mode 100644 docs/equinix_metalv1_v-r-fs_get-vrf-b-g-p-neighbors.md create mode 100644 docs/equinix_metalv1_v-r-fs_get-vrf-learned-routes.md create mode 100644 docs/equinix_metalv1_v-r-fs_get-vrf-routes.md create mode 100644 docs/equinix_metalv1_v-r-fs_update-vrf-route-by-id.md create mode 100644 docs/equinix_metalv1_v-r-fs_update-vrf.md create mode 100644 docs/equinix_orderhistoryv1.md create mode 100644 docs/equinix_orderhistoryv1_retrieve-orders.md create mode 100644 docs/equinix_orderhistoryv1_retrieve-orders_g-e-t-retrieve-orders-locations.md create mode 100644 docs/equinix_orderhistoryv1_retrieve-orders_p-o-s-t-orders-history.md create mode 100644 docs/equinix_ordersv2.md create mode 100644 docs/equinix_ordersv2_orders.md create mode 100644 docs/equinix_ordersv2_orders_add-notes-to-an-order.md create mode 100644 docs/equinix_ordersv2_orders_cancel-an-order.md create mode 100644 docs/equinix_ordersv2_orders_g-e-t-order-details.md create mode 100644 docs/equinix_ordersv2_orders_reply-to-an-order-negotiation.md create mode 100644 docs/equinix_ordersv2_orders_retrieve-order-negotiations.md create mode 100644 docs/equinix_securecabinetv1.md create mode 100644 docs/equinix_securecabinetv1_availability.md create mode 100644 docs/equinix_securecabinetv1_availability_get-products-availability.md create mode 100644 docs/equinix_securecabinetv1_orders.md create mode 100644 docs/equinix_securecabinetv1_orders_create-order.md create mode 100644 docs/equinix_smarthandsv1.md create mode 100644 docs/equinix_smarthandsv1_smarthands.md create mode 100644 docs/equinix_smarthandsv1_smarthands_get-location.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cable-request-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cage-cleanup-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cage-escort-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-locate-package-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-move-jumper-cable-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-others-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-patch-cable-install-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-patch-cable-removal-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-pictures-document-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-run-jumper-cable-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_handle-smart-hand-shipment-unpack-order.md create mode 100644 docs/equinix_smarthandsv1_smarthands_smart-hand-types.md create mode 100644 docs/equinix_stsv1alpha.md create mode 100644 docs/equinix_stsv1alpha_use.md create mode 100644 docs/equinix_stsv1alpha_use_use-token-post.md diff --git a/docs/equinix.md b/docs/equinix.md index a9ecb7a..032d539 100644 --- a/docs/equinix.md +++ b/docs/equinix.md @@ -15,8 +15,18 @@ Command-line interface for Equinix APIs ### SEE ALSO +* [equinix accesstokenv1](equinix_accesstokenv1.md) - Manage Equinix accesstokenv1 resources * [equinix api](equinix_api.md) - Make a raw API request to the given Equinix API path * [equinix completion](equinix_completion.md) - Generate the autocompletion script for the specified shell * [equinix docs](equinix_docs.md) - Generate markdown documentation for this CLI +* [equinix eiav2](equinix_eiav2.md) - Manage Equinix eiav2 resources +* [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix lookupv2](equinix_lookupv2.md) - Manage Equinix lookupv2 resources +* [equinix metalv1](equinix_metalv1.md) - Manage Equinix metalv1 resources +* [equinix orderhistoryv1](equinix_orderhistoryv1.md) - Manage Equinix orderhistoryv1 resources +* [equinix ordersv2](equinix_ordersv2.md) - Manage Equinix ordersv2 resources +* [equinix securecabinetv1](equinix_securecabinetv1.md) - Manage Equinix securecauinetv1 resources +* [equinix smarthandsv1](equinix_smarthandsv1.md) - Manage Equinix smarthandsv1 resources +* [equinix stsv1alpha](equinix_stsv1alpha.md) - Manage Equinix stsv1alpha resources * [equinix version](equinix_version.md) - Print version information for this CLI diff --git a/docs/equinix_accesstokenv1.md b/docs/equinix_accesstokenv1.md new file mode 100644 index 0000000..c37a824 --- /dev/null +++ b/docs/equinix_accesstokenv1.md @@ -0,0 +1,30 @@ +## equinix accesstokenv1 + +Manage Equinix accesstokenv1 resources + +### Synopsis + +Commands for managing Equinix accesstokenv1 resources. + +The accesstokenv1 commands are dynamically generated based on the accesstokenv1 API client, +providing access to all available API services. + +### Options + +``` + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") + -h, --help help for accesstokenv1 +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) +``` + +### SEE ALSO + +* [equinix](equinix.md) - Equinix CLI +* [equinix accesstokenv1 o-auth2-token](equinix_accesstokenv1_o-auth2-token.md) - Manage o-auth2-token resources + diff --git a/docs/equinix_accesstokenv1_o-auth2-token.md b/docs/equinix_accesstokenv1_o-auth2-token.md new file mode 100644 index 0000000..4734017 --- /dev/null +++ b/docs/equinix_accesstokenv1_o-auth2-token.md @@ -0,0 +1,28 @@ +## 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_o-auth2-token_get-o-auth2-access-token.md b/docs/equinix_accesstokenv1_o-auth2-token_get-o-auth2-access-token.md new file mode 100644 index 0000000..740cd61 --- /dev/null +++ b/docs/equinix_accesstokenv1_o-auth2-token_get-o-auth2-access-token.md @@ -0,0 +1,40 @@ +## equinix accesstokenv1 o-auth2-token get-o-auth2-access-token + +Generate New Access Token + +### 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. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix accesstokenv1 o-auth2-token get-o-auth2-access-token [flags] +``` + +### Options + +``` + -h, --help help for get-o-auth2-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 + --payload-grant_type string The OAuth2 grant type used for authorization. Supported values are \"password\" & \"client_credentials\". user_name and password is not considered in case this value is \"client_credentials\". If the grant_type is not passed, by default it would consider \"password\" type in which user_name and password is required. Note that the password grant type is deprecated. Recommended to use grant_type of 'client_credentials' instead. + --payload-password_encoding string For enhanced security, you may encrypt the password value while requesting for an access_token. Currently only \"md5-b64\" hashing is supported. Any other value would treat password value as raw string + --payload-user_name string Deprecated - The Equinix username used to access portals + --payload-user_password string Deprecated - The Equinix user password used to access portals + --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 accesstokenv1 o-auth2-token](equinix_accesstokenv1_o-auth2-token.md) - Manage o-auth2-token resources + diff --git a/docs/equinix_accesstokenv1_o-auth2-token_refresh-o-auth2-access-token.md b/docs/equinix_accesstokenv1_o-auth2-token_refresh-o-auth2-access-token.md new file mode 100644 index 0000000..5b9940d --- /dev/null +++ b/docs/equinix_accesstokenv1_o-auth2-token_refresh-o-auth2-access-token.md @@ -0,0 +1,37 @@ +## equinix accesstokenv1 o-auth2-token refresh-o-auth2-access-token + +Renew Access Tokens + +### 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. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix accesstokenv1 o-auth2-token refresh-o-auth2-access-token [flags] +``` + +### Options + +``` + -h, --help help for refresh-o-auth2-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 + --payload-refresh_token string The OAuth2 refresh_token retrieved from the previous successful Access Token API call + --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 accesstokenv1 o-auth2-token](equinix_accesstokenv1_o-auth2-token.md) - Manage o-auth2-token resources + diff --git a/docs/equinix_eiav2.md b/docs/equinix_eiav2.md new file mode 100644 index 0000000..5bee68c --- /dev/null +++ b/docs/equinix_eiav2.md @@ -0,0 +1,30 @@ +## equinix eiav2 + +Manage Equinix eiav2 resources + +### Synopsis + +Commands for managing Equinix eiav2 resources. + +The eiav2 commands are dynamically generated based on the eiav2 API client, +providing access to all available API services. + +### Options + +``` + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") + -h, --help help for eiav2 +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) +``` + +### 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 + diff --git a/docs/equinix_eiav2_e-i-a-service.md b/docs/equinix_eiav2_e-i-a-service.md new file mode 100644 index 0000000..b609263 --- /dev/null +++ b/docs/equinix_eiav2_e-i-a-service.md @@ -0,0 +1,27 @@ +## equinix eiav2 e-i-a-service + +Manage e-i-a-service resources + +### Synopsis + +Commands for managing e-i-a-service resources in the API + +### Options + +``` + -h, --help help for e-i-a-service +``` + +### 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 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 + diff --git a/docs/equinix_eiav2_e-i-a-service_create-equinix-internet-accessv2.md b/docs/equinix_eiav2_e-i-a-service_create-equinix-internet-accessv2.md new file mode 100644 index 0000000..50ac59b --- /dev/null +++ b/docs/equinix_eiav2_e-i-a-service_create-equinix-internet-accessv2.md @@ -0,0 +1,52 @@ +## equinix eiav2 e-i-a-service create-equinix-internet-accessv2 + +Execute create-equinix-internet-accessv2 operation + +### Synopsis + +Execute the create-equinix-internet-accessv2 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 eiav2 e-i-a-service create-equinix-internet-accessv2 [flags] +``` + +### Options + +``` + -h, --help help for create-equinix-internet-accessv2 + --request string JSON payload for additional optional fields not exposed as flags + --service-request-additional-properties string service-request-additional-properties (JSON) + --service-request-connections string Collection of service connections uuids (JSON array) + --service-request-description string service-request-description + --service-request-name string service-request-name + --service-request-order-additional-properties string service-request-order-additional-properties (JSON) + --service-request-order-contacts string service-request-order-contacts (JSON array) + --service-request-order-draft service-request-order-draft + --service-request-order-purchase-order string service-request-order-purchase-order (JSON) + --service-request-order-reference-number string service-request-order-reference-number + --service-request-order-signature string service-request-order-signature (JSON) + --service-request-order-tags string service-request-order-tags (JSON array) + --service-request-routing-protocol-bgp-routing-protocol-request string service-request-routing-protocol-bgp-routing-protocol-request (JSON) + --service-request-routing-protocol-direct-routing-protocol-request string service-request-routing-protocol-direct-routing-protocol-request (JSON) + --service-request-routing-protocol-static-routing-protocol-request string service-request-routing-protocol-static-routing-protocol-request (JSON) + --service-request-tags string service-request-tags (JSON array) + --service-request-type string service-request-type +``` + +### 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 eiav2 e-i-a-service](equinix_eiav2_e-i-a-service.md) - Manage e-i-a-service resources + diff --git a/docs/equinix_fabricv4.md b/docs/equinix_fabricv4.md new file mode 100644 index 0000000..6bae8aa --- /dev/null +++ b/docs/equinix_fabricv4.md @@ -0,0 +1,52 @@ +## equinix fabricv4 + +Manage Equinix fauricv4 resources + +### Synopsis + +Commands for managing Equinix fauricv4 resources. + +The fabricv4 commands are dynamically generated based on the fauricv4 API client, +providing access to all available API services. + +### Options + +``` + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") + -h, --help help for fabricv4 +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) +``` + +### SEE ALSO + +* [equinix](equinix.md) - Equinix CLI +* [equinix fabricv4 cloud-events](equinix_fabricv4_cloud-events.md) - Manage cloud-events resources +* [equinix fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources +* [equinix fabricv4 connections](equinix_fabricv4_connections.md) - Manage connections resources +* [equinix fabricv4 health](equinix_fabricv4_health.md) - Manage health resources +* [equinix fabricv4 marketplace-subscriptions](equinix_fabricv4_marketplace-subscriptions.md) - Manage marketplace-subscriptions resources +* [equinix fabricv4 metrics](equinix_fabricv4_metrics.md) - Manage metrics resources +* [equinix fabricv4 metros](equinix_fabricv4_metros.md) - Manage metros resources +* [equinix fabricv4 networks](equinix_fabricv4_networks.md) - Manage networks resources +* [equinix fabricv4 port-packages](equinix_fabricv4_port-packages.md) - Manage port-packages resources +* [equinix fabricv4 ports](equinix_fabricv4_ports.md) - Manage ports resources +* [equinix fabricv4 precision-time](equinix_fabricv4_precision-time.md) - Manage precision-time resources +* [equinix fabricv4 prices](equinix_fabricv4_prices.md) - Manage prices resources +* [equinix fabricv4 route-aggregation-rules](equinix_fabricv4_route-aggregation-rules.md) - Manage route-aggregation-rules resources +* [equinix fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources +* [equinix fabricv4 route-filter-rules](equinix_fabricv4_route-filter-rules.md) - Manage route-filter-rules resources +* [equinix fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources +* [equinix fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources +* [equinix fabricv4 service-profiles](equinix_fabricv4_service-profiles.md) - Manage service-profiles resources +* [equinix fabricv4 service-tokens](equinix_fabricv4_service-tokens.md) - Manage service-tokens resources +* [equinix fabricv4 statistics](equinix_fabricv4_statistics.md) - Manage statistics resources +* [equinix fabricv4 stream-alert-rules](equinix_fabricv4_stream-alert-rules.md) - Manage stream-alert-rules resources +* [equinix fabricv4 stream-subscriptions](equinix_fabricv4_stream-subscriptions.md) - Manage stream-subscriptions resources +* [equinix fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources + diff --git a/docs/equinix_fabricv4_cloud-events.md b/docs/equinix_fabricv4_cloud-events.md new file mode 100644 index 0000000..ccdcd72 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-events.md @@ -0,0 +1,29 @@ +## equinix fabricv4 cloud-events + +Manage cloud-events resources + +### Synopsis + +Commands for managing cloud-events resources in the API + +### Options + +``` + -h, --help help for cloud-events +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 cloud-events get-cloud-event](equinix_fabricv4_cloud-events_get-cloud-event.md) - Get Cloud Event +* [equinix fabricv4 cloud-events get-cloud-event-by-asset-id](equinix_fabricv4_cloud-events_get-cloud-event-by-asset-id.md) - Get Cloud Events by Asset Id +* [equinix fabricv4 cloud-events search-cloud-events](equinix_fabricv4_cloud-events_search-cloud-events.md) - Search Cloud Events + diff --git a/docs/equinix_fabricv4_cloud-events_get-cloud-event-by-asset-id.md b/docs/equinix_fabricv4_cloud-events_get-cloud-event-by-asset-id.md new file mode 100644 index 0000000..79e65c1 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-events_get-cloud-event-by-asset-id.md @@ -0,0 +1,37 @@ +## equinix fabricv4 cloud-events get-cloud-event-by-asset-id + +Get Cloud Events by Asset Id + +### Synopsis + +This API provides capability to retrieve cloud events of an asset id + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-events get-cloud-event-by-asset-id [flags] +``` + +### Options + +``` + --asset string asset (required) + --asset-id string asset UUID (required) + -h, --help help for get-cloud-event-by-asset-id + --limit int limit field + --offset int offset 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 fabricv4 cloud-events](equinix_fabricv4_cloud-events.md) - Manage cloud-events resources + diff --git a/docs/equinix_fabricv4_cloud-events_get-cloud-event.md b/docs/equinix_fabricv4_cloud-events_get-cloud-event.md new file mode 100644 index 0000000..54fcd16 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-events_get-cloud-event.md @@ -0,0 +1,34 @@ +## equinix fabricv4 cloud-events get-cloud-event + +Get Cloud Event + +### Synopsis + +This API provides capability to retrieve a cloud event by uuid + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-events get-cloud-event [flags] +``` + +### Options + +``` + --cloud-event-id string Cloud Event UUID (required) + -h, --help help for get-cloud-event + --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 fabricv4 cloud-events](equinix_fabricv4_cloud-events.md) - Manage cloud-events resources + diff --git a/docs/equinix_fabricv4_cloud-events_search-cloud-events.md b/docs/equinix_fabricv4_cloud-events_search-cloud-events.md new file mode 100644 index 0000000..8b3e63d --- /dev/null +++ b/docs/equinix_fabricv4_cloud-events_search-cloud-events.md @@ -0,0 +1,39 @@ +## equinix fabricv4 cloud-events search-cloud-events + +Search Cloud Events + +### Synopsis + +This API provides capability to search cloud events from a filtered query + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-events search-cloud-events [flags] +``` + +### Options + +``` + --cloud-event-search-request-additional-properties string cloud-event-search-request-additional-properties (JSON) + --cloud-event-search-request-filter-additional-properties string cloud-event-search-request-filter-additional-properties (JSON) + --cloud-event-search-request-filter-and string cloud-event-search-request-filter-and (JSON array) + --cloud-event-search-request-pagination-additional-properties string cloud-event-search-request-pagination-additional-properties (JSON) + --cloud-event-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --cloud-event-search-request-pagination-offset int Index of the first element. + -h, --help help for search-cloud-events + --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 fabricv4 cloud-events](equinix_fabricv4_cloud-events.md) - Manage cloud-events resources + diff --git a/docs/equinix_fabricv4_cloud-routers.md b/docs/equinix_fabricv4_cloud-routers.md new file mode 100644 index 0000000..774c4eb --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers.md @@ -0,0 +1,47 @@ +## equinix fabricv4 cloud-routers + +Manage cloud-routers resources + +### Synopsis + +Commands for managing cloud-routers resources in the API + +### Options + +``` + -h, --help help for cloud-routers +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 cloud-routers create-cloud-router](equinix_fabricv4_cloud-routers_create-cloud-router.md) - Create Routers +* [equinix fabricv4 cloud-routers create-cloud-router-action](equinix_fabricv4_cloud-routers_create-cloud-router-action.md) - Create Route Table Action +* [equinix fabricv4 cloud-routers create-cloud-router-command](equinix_fabricv4_cloud-routers_create-cloud-router-command.md) - Initiate Command +* [equinix fabricv4 cloud-routers delete-cloud-router-by-uuid](equinix_fabricv4_cloud-routers_delete-cloud-router-by-uuid.md) - Delete Routers +* [equinix fabricv4 cloud-routers delete-cloud-router-command-by-uuid](equinix_fabricv4_cloud-routers_delete-cloud-router-command-by-uuid.md) - Delete Command +* [equinix fabricv4 cloud-routers get-all-cloud-router-commands](equinix_fabricv4_cloud-routers_get-all-cloud-router-commands.md) - Get Commands +* [equinix fabricv4 cloud-routers get-cloud-router-actions](equinix_fabricv4_cloud-routers_get-cloud-router-actions.md) - Get Route Table Actions +* [equinix fabricv4 cloud-routers get-cloud-router-actions-by-uuid](equinix_fabricv4_cloud-routers_get-cloud-router-actions-by-uuid.md) - Get Route Table Action by ID +* [equinix fabricv4 cloud-routers get-cloud-router-by-uuid](equinix_fabricv4_cloud-routers_get-cloud-router-by-uuid.md) - Get Routers +* [equinix fabricv4 cloud-routers get-cloud-router-command](equinix_fabricv4_cloud-routers_get-cloud-router-command.md) - Get Command +* [equinix fabricv4 cloud-routers get-cloud-router-package-by-code](equinix_fabricv4_cloud-routers_get-cloud-router-package-by-code.md) - Get Package Details +* [equinix fabricv4 cloud-routers get-cloud-router-packages](equinix_fabricv4_cloud-routers_get-cloud-router-packages.md) - List Packages +* [equinix fabricv4 cloud-routers get-gateway-attachment-to-cloud-router-by-uuid](equinix_fabricv4_cloud-routers_get-gateway-attachment-to-cloud-router-by-uuid.md) - Get Gateway Attachment details to a Cloud Router +* [equinix fabricv4 cloud-routers list-gateway-attachments-to-cloud-router](equinix_fabricv4_cloud-routers_list-gateway-attachments-to-cloud-router.md) - List Cloud Routers of a Gateway Attachment. +* [equinix fabricv4 cloud-routers search-cloud-router-commands](equinix_fabricv4_cloud-routers_search-cloud-router-commands.md) - Search Commands +* [equinix fabricv4 cloud-routers search-cloud-router-routes](equinix_fabricv4_cloud-routers_search-cloud-router-routes.md) - Search Route Table +* [equinix fabricv4 cloud-routers search-cloud-routers](equinix_fabricv4_cloud-routers_search-cloud-routers.md) - Search Routers +* [equinix fabricv4 cloud-routers search-connection-advertised-routes](equinix_fabricv4_cloud-routers_search-connection-advertised-routes.md) - Search Advertised Routes +* [equinix fabricv4 cloud-routers search-connection-received-routes](equinix_fabricv4_cloud-routers_search-connection-received-routes.md) - Search Received Routes +* [equinix fabricv4 cloud-routers search-router-actions](equinix_fabricv4_cloud-routers_search-router-actions.md) - Search Route Table Actions +* [equinix fabricv4 cloud-routers update-cloud-router-by-uuid](equinix_fabricv4_cloud-routers_update-cloud-router-by-uuid.md) - Update Routers + diff --git a/docs/equinix_fabricv4_cloud-routers_create-cloud-router-action.md b/docs/equinix_fabricv4_cloud-routers_create-cloud-router-action.md new file mode 100644 index 0000000..5902a0f --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_create-cloud-router-action.md @@ -0,0 +1,41 @@ +## equinix fabricv4 cloud-routers create-cloud-router-action + +Create Route Table Action + +### Synopsis + +This API provides capability to refresh route table and bgp session summary information + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers create-cloud-router-action [flags] +``` + +### Options + +``` + --cloud-router-action-request-additional-properties string cloud-router-action-request-additional-properties (JSON) + --cloud-router-action-request-connection-additional-properties string cloud-router-action-request-connection-additional-properties (JSON) + --cloud-router-action-request-connection-href string cloud-router-action-request-connection-href + --cloud-router-action-request-connection-operation string cloud-router-action-request-connection-operation (JSON) + --cloud-router-action-request-connection-type string cloud-router-action-request-connection-type + --cloud-router-action-request-connection-uuid string Connection UUID + --cloud-router-action-request-type string cloud-router-action-request-type + -h, --help help for create-cloud-router-action + --request string JSON payload for additional optional fields not exposed as flags + --router-id string Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_create-cloud-router-command.md b/docs/equinix_fabricv4_cloud-routers_create-cloud-router-command.md new file mode 100644 index 0000000..d8bbdf7 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_create-cloud-router-command.md @@ -0,0 +1,47 @@ +## equinix fabricv4 cloud-routers create-cloud-router-command + +Initiate Command + +### Synopsis + +This API provides capability to initiate Command + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers create-cloud-router-command [flags] +``` + +### Options + +``` + --cloud-router-command-post-request-additional-properties string cloud-router-command-post-request-additional-properties (JSON) + --cloud-router-command-post-request-description string Customer-provided Cloud Router Command description + --cloud-router-command-post-request-name string Customer-provided Cloud Router Command name + --cloud-router-command-post-request-project-additional-properties string cloud-router-command-post-request-project-additional-properties (JSON) + --cloud-router-command-post-request-project-project-id string Subscriber-assigned project ID + --cloud-router-command-post-request-request-additional-properties string cloud-router-command-post-request-request-additional-properties (JSON) + --cloud-router-command-post-request-request-data-bytes PING_COMMAND Ping Command DataBytes. This field is only applicable for commands of type PING_COMMAND. + --cloud-router-command-post-request-request-destination string Fabric Cloud Router Ping or Traceroute Command Destination + --cloud-router-command-post-request-request-hops-max TRACEROUTE_COMMAND Maximum number of hops for the traceroute command. This field is only applicable for commands of type TRACEROUTE_COMMAND. + --cloud-router-command-post-request-request-probes TRACEROUTE_COMMAND Number of probes for Fabric Cloud Router Traceroute Command. This field is only applicable for commands of type TRACEROUTE_COMMAND and is not configurable. + --cloud-router-command-post-request-request-source-connection string cloud-router-command-post-request-request-source-connection (JSON) + --cloud-router-command-post-request-request-timeout PING_COMMAND Timeout in seconds for Fabric Cloud Router Command: - For PING_COMMAND: Packet timeout duration. The default value is 5. - For `TRACEROUTE_COMMAND`: Probe timeout duration. The default value is 2 and it is not configurable. + --cloud-router-command-post-request-type string cloud-router-command-post-request-type + -h, --help help for create-cloud-router-command + --request string JSON payload for additional optional fields not exposed as flags + --router-id string Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_create-cloud-router.md b/docs/equinix_fabricv4_cloud-routers_create-cloud-router.md new file mode 100644 index 0000000..9af1f67 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_create-cloud-router.md @@ -0,0 +1,73 @@ +## equinix fabricv4 cloud-routers create-cloud-router + +Create Routers + +### Synopsis + +This API provides capability to create user's Cloud Routers + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers create-cloud-router [flags] +``` + +### Options + +``` + --cloud-router-post-request-account-account-name string Account name + --cloud-router-post-request-account-account-number int Account number + --cloud-router-post-request-account-additional-properties string cloud-router-post-request-account-additional-properties (JSON) + --cloud-router-post-request-account-global-cust-id string Account name + --cloud-router-post-request-account-global-org-id string Global organization identifier + --cloud-router-post-request-account-global-organization-name string Global organization name + --cloud-router-post-request-account-org-id int Customer organization identifier + --cloud-router-post-request-account-organization-name string Customer organization name + --cloud-router-post-request-account-reseller-account-name string Reseller account name + --cloud-router-post-request-account-reseller-account-number int Reseller account number + --cloud-router-post-request-account-reseller-org-id int Reseller customer organization identifier + --cloud-router-post-request-account-reseller-ucm-id string Reseller account ucmId + --cloud-router-post-request-account-ucm-id string Account ucmId + --cloud-router-post-request-additional-properties string cloud-router-post-request-additional-properties (JSON) + --cloud-router-post-request-location-additional-properties string cloud-router-post-request-location-additional-properties (JSON) + --cloud-router-post-request-location-metro-code string cloud-router-post-request-location-metro-code + --cloud-router-post-request-location-metro-href string The Canonical URL at which the resource resides. + --cloud-router-post-request-location-metro-name string cloud-router-post-request-location-metro-name + --cloud-router-post-request-location-region string cloud-router-post-request-location-region + --cloud-router-post-request-marketplace-subscription-additional-properties string cloud-router-post-request-marketplace-subscription-additional-properties (JSON) + --cloud-router-post-request-marketplace-subscription-href string Marketplace Subscription URI + --cloud-router-post-request-marketplace-subscription-type string cloud-router-post-request-marketplace-subscription-type + --cloud-router-post-request-marketplace-subscription-uuid string Equinix-assigned Marketplace Subscription identifier + --cloud-router-post-request-name string Customer-provided Cloud Router name + --cloud-router-post-request-notifications string Preferences for notifications on connection configuration or status changes (JSON array) + --cloud-router-post-request-order-additional-properties string cloud-router-post-request-order-additional-properties (JSON) + --cloud-router-post-request-order-billing-tier string Billing tier for connection bandwidth + --cloud-router-post-request-order-customer-reference-number string Customer reference number + --cloud-router-post-request-order-order-id string Order Identification + --cloud-router-post-request-order-order-number string Order Reference Number + --cloud-router-post-request-order-purchase-order-number string Purchase order number + --cloud-router-post-request-order-term-length int Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case). + --cloud-router-post-request-package-additional-properties string cloud-router-post-request-package-additional-properties (JSON) + --cloud-router-post-request-package-code string cloud-router-post-request-package-code + --cloud-router-post-request-package-href string Fabric Cloud Router URI + --cloud-router-post-request-package-type string cloud-router-post-request-package-type + --cloud-router-post-request-project-additional-properties string cloud-router-post-request-project-additional-properties (JSON) + --cloud-router-post-request-project-project-id string Subscriber-assigned project ID + --cloud-router-post-request-type string cloud-router-post-request-type + --dry-run dry-run field + -h, --help help for create-cloud-router + --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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_delete-cloud-router-by-uuid.md b/docs/equinix_fabricv4_cloud-routers_delete-cloud-router-by-uuid.md new file mode 100644 index 0000000..05bf830 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_delete-cloud-router-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 cloud-routers delete-cloud-router-by-uuid + +Delete Routers + +### Synopsis + +This API provides capability to delete user's Cloud Routers + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers delete-cloud-router-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-cloud-router-by-uuid + --request string JSON payload for request body fields + --router-id string Cloud Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_delete-cloud-router-command-by-uuid.md b/docs/equinix_fabricv4_cloud-routers_delete-cloud-router-command-by-uuid.md new file mode 100644 index 0000000..047664a --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_delete-cloud-router-command-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 cloud-routers delete-cloud-router-command-by-uuid + +Delete Command + +### Synopsis + +This API provides capability to delete command based on command Id + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers delete-cloud-router-command-by-uuid [flags] +``` + +### Options + +``` + --command-id string Command UUID (required) + -h, --help help for delete-cloud-router-command-by-uuid + --request string JSON payload for request body fields + --router-id string Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_get-all-cloud-router-commands.md b/docs/equinix_fabricv4_cloud-routers_get-all-cloud-router-commands.md new file mode 100644 index 0000000..ae9a725 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_get-all-cloud-router-commands.md @@ -0,0 +1,34 @@ +## equinix fabricv4 cloud-routers get-all-cloud-router-commands + +Get Commands + +### Synopsis + +This API provides capability to fetch all commands + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers get-all-cloud-router-commands [flags] +``` + +### Options + +``` + -h, --help help for get-all-cloud-router-commands + --request string JSON payload for request body fields + --router-id string Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_get-cloud-router-actions-by-uuid.md b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-actions-by-uuid.md new file mode 100644 index 0000000..05128d5 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-actions-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 cloud-routers get-cloud-router-actions-by-uuid + +Get Route Table Action by ID + +### Synopsis + +This API provides capability to fetch action status + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers get-cloud-router-actions-by-uuid [flags] +``` + +### Options + +``` + --action-id string Action UUID (required) + -h, --help help for get-cloud-router-actions-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --router-id string Router UUID (required) + --state string state 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_get-cloud-router-actions.md b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-actions.md new file mode 100644 index 0000000..86d48bd --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-actions.md @@ -0,0 +1,35 @@ +## equinix fabricv4 cloud-routers get-cloud-router-actions + +Get Route Table Actions + +### Synopsis + +This API provides capability to fetch action status + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers get-cloud-router-actions [flags] +``` + +### Options + +``` + -h, --help help for get-cloud-router-actions + --request string JSON payload for additional optional fields not exposed as flags + --router-id string Router UUID (required) + --state string state 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_get-cloud-router-by-uuid.md b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-by-uuid.md new file mode 100644 index 0000000..234d7da --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 cloud-routers get-cloud-router-by-uuid + +Get Routers + +### Synopsis + +This API provides capability to retrieve user's Cloud Routers + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers get-cloud-router-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-cloud-router-by-uuid + --request string JSON payload for request body fields + --router-id string Cloud Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_get-cloud-router-command.md b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-command.md new file mode 100644 index 0000000..0c2b7b2 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-command.md @@ -0,0 +1,35 @@ +## equinix fabricv4 cloud-routers get-cloud-router-command + +Get Command + +### Synopsis + +This API provides capability to fetch command using command Id + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers get-cloud-router-command [flags] +``` + +### Options + +``` + --command-id string Command UUID (required) + -h, --help help for get-cloud-router-command + --request string JSON payload for request body fields + --router-id string Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_get-cloud-router-package-by-code.md b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-package-by-code.md new file mode 100644 index 0000000..bb5ec27 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-package-by-code.md @@ -0,0 +1,34 @@ +## equinix fabricv4 cloud-routers get-cloud-router-package-by-code + +Get Package Details + +### Synopsis + +This API provides capability to retrieve user's Cloud Routers Package Details + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers get-cloud-router-package-by-code [flags] +``` + +### Options + +``` + -h, --help help for get-cloud-router-package-by-code + --request string JSON payload for request body fields + --router-package-code string assigned Cloud Router package identifier (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_get-cloud-router-packages.md b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-packages.md new file mode 100644 index 0000000..120126b --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_get-cloud-router-packages.md @@ -0,0 +1,35 @@ +## equinix fabricv4 cloud-routers get-cloud-router-packages + +List Packages + +### Synopsis + +This API provides capability to retrieve user's Cloud Routers Packages + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers get-cloud-router-packages [flags] +``` + +### Options + +``` + -h, --help help for get-cloud-router-packages + --limit int limit field + --offset int offset 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_get-gateway-attachment-to-cloud-router-by-uuid.md b/docs/equinix_fabricv4_cloud-routers_get-gateway-attachment-to-cloud-router-by-uuid.md new file mode 100644 index 0000000..fcb804e --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_get-gateway-attachment-to-cloud-router-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 cloud-routers get-gateway-attachment-to-cloud-router-by-uuid + +Get Gateway Attachment details to a Cloud Router + +### Synopsis + +Get details of a Specific Gateway Attachment to a Cloud Router. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers get-gateway-attachment-to-cloud-router-by-uuid [flags] +``` + +### Options + +``` + --gateway-id string Gateway UUID (required) + -h, --help help for get-gateway-attachment-to-cloud-router-by-uuid + --request string JSON payload for request body fields + --router-id string Cloud Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_list-gateway-attachments-to-cloud-router.md b/docs/equinix_fabricv4_cloud-routers_list-gateway-attachments-to-cloud-router.md new file mode 100644 index 0000000..3222bd7 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_list-gateway-attachments-to-cloud-router.md @@ -0,0 +1,36 @@ +## equinix fabricv4 cloud-routers list-gateway-attachments-to-cloud-router + +List Cloud Routers of a Gateway Attachment. + +### Synopsis + +Get all Cloud Routers attached on a Gateway. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers list-gateway-attachments-to-cloud-router [flags] +``` + +### Options + +``` + --gateway-id string Gateway UUID (required) + -h, --help help for list-gateway-attachments-to-cloud-router + --limit int limit field + --offset int offset 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_search-cloud-router-commands.md b/docs/equinix_fabricv4_cloud-routers_search-cloud-router-commands.md new file mode 100644 index 0000000..2182479 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_search-cloud-router-commands.md @@ -0,0 +1,41 @@ +## equinix fabricv4 cloud-routers search-cloud-router-commands + +Search Commands + +### Synopsis + +This API provides capability to search commands + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers search-cloud-router-commands [flags] +``` + +### Options + +``` + --cloud-router-command-search-request-additional-properties string cloud-router-command-search-request-additional-properties (JSON) + --cloud-router-command-search-request-filter-additional-properties string cloud-router-command-search-request-filter-additional-properties (JSON) + --cloud-router-command-search-request-filter-and string cloud-router-command-search-request-filter-and (JSON array) + --cloud-router-command-search-request-pagination-additional-properties string cloud-router-command-search-request-pagination-additional-properties (JSON) + --cloud-router-command-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --cloud-router-command-search-request-pagination-offset int Index of the first element. + --cloud-router-command-search-request-sort string cloud-router-command-search-request-sort (JSON array) + -h, --help help for search-cloud-router-commands + --request string JSON payload for additional optional fields not exposed as flags + --router-id string Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_search-cloud-router-routes.md b/docs/equinix_fabricv4_cloud-routers_search-cloud-router-routes.md new file mode 100644 index 0000000..8bc4f7c --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_search-cloud-router-routes.md @@ -0,0 +1,41 @@ +## equinix fabricv4 cloud-routers search-cloud-router-routes + +Search Route Table + +### Synopsis + +The API provides capability to get list of user's Fabric Cloud Router route table entries using search criteria, including optional filtering, pagination and sorting + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers search-cloud-router-routes [flags] +``` + +### Options + +``` + -h, --help help for search-cloud-router-routes + --request string JSON payload for additional optional fields not exposed as flags + --route-table-entry-search-request-additional-properties string route-table-entry-search-request-additional-properties (JSON) + --route-table-entry-search-request-filter-additional-properties string route-table-entry-search-request-filter-additional-properties (JSON) + --route-table-entry-search-request-filter-and string route-table-entry-search-request-filter-and (JSON array) + --route-table-entry-search-request-pagination-additional-properties string route-table-entry-search-request-pagination-additional-properties (JSON) + --route-table-entry-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --route-table-entry-search-request-pagination-offset int Index of the first element. + --route-table-entry-search-request-sort string route-table-entry-search-request-sort (JSON array) + --router-id string Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_search-cloud-routers.md b/docs/equinix_fabricv4_cloud-routers_search-cloud-routers.md new file mode 100644 index 0000000..66fe00a --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_search-cloud-routers.md @@ -0,0 +1,40 @@ +## equinix fabricv4 cloud-routers search-cloud-routers + +Search Routers + +### Synopsis + +The API provides capability to get list of user's Cloud Routers using search criteria, including optional filtering, pagination and sorting + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers search-cloud-routers [flags] +``` + +### Options + +``` + --cloud-router-search-request-additional-properties string cloud-router-search-request-additional-properties (JSON) + --cloud-router-search-request-filter-additional-properties string cloud-router-search-request-filter-additional-properties (JSON) + --cloud-router-search-request-filter-and string cloud-router-search-request-filter-and (JSON array) + --cloud-router-search-request-pagination-additional-properties string cloud-router-search-request-pagination-additional-properties (JSON) + --cloud-router-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --cloud-router-search-request-pagination-offset int Index of the first element. + --cloud-router-search-request-sort string cloud-router-search-request-sort (JSON array) + -h, --help help for search-cloud-routers + --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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_search-connection-advertised-routes.md b/docs/equinix_fabricv4_cloud-routers_search-connection-advertised-routes.md new file mode 100644 index 0000000..5997714 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_search-connection-advertised-routes.md @@ -0,0 +1,41 @@ +## equinix fabricv4 cloud-routers search-connection-advertised-routes + +Search Advertised Routes + +### Synopsis + +The API provides capability to get list of user's advertised routes using search criteria, including optional filtering, pagination and sorting + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers search-connection-advertised-routes [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + --connection-route-search-request-additional-properties string connection-route-search-request-additional-properties (JSON) + --connection-route-search-request-filter-additional-properties string connection-route-search-request-filter-additional-properties (JSON) + --connection-route-search-request-filter-and string connection-route-search-request-filter-and (JSON array) + --connection-route-search-request-pagination-additional-properties string connection-route-search-request-pagination-additional-properties (JSON) + --connection-route-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --connection-route-search-request-pagination-offset int Index of the first element. + --connection-route-search-request-sort string connection-route-search-request-sort (JSON array) + -h, --help help for search-connection-advertised-routes + --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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_search-connection-received-routes.md b/docs/equinix_fabricv4_cloud-routers_search-connection-received-routes.md new file mode 100644 index 0000000..ff768f2 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_search-connection-received-routes.md @@ -0,0 +1,41 @@ +## equinix fabricv4 cloud-routers search-connection-received-routes + +Search Received Routes + +### Synopsis + +The API provides capability to get list of received routes using search criteria, including optional filtering, pagination and sorting + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers search-connection-received-routes [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + --connection-route-search-request-additional-properties string connection-route-search-request-additional-properties (JSON) + --connection-route-search-request-filter-additional-properties string connection-route-search-request-filter-additional-properties (JSON) + --connection-route-search-request-filter-and string connection-route-search-request-filter-and (JSON array) + --connection-route-search-request-pagination-additional-properties string connection-route-search-request-pagination-additional-properties (JSON) + --connection-route-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --connection-route-search-request-pagination-offset int Index of the first element. + --connection-route-search-request-sort string connection-route-search-request-sort (JSON array) + -h, --help help for search-connection-received-routes + --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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_search-router-actions.md b/docs/equinix_fabricv4_cloud-routers_search-router-actions.md new file mode 100644 index 0000000..88e23b9 --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_search-router-actions.md @@ -0,0 +1,41 @@ +## equinix fabricv4 cloud-routers search-router-actions + +Search Route Table Actions + +### Synopsis + +This API provides capability to refresh route table and bgp session summary information + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers search-router-actions [flags] +``` + +### Options + +``` + --cloud-router-actions-search-request-additional-properties string cloud-router-actions-search-request-additional-properties (JSON) + --cloud-router-actions-search-request-filter-additional-properties string cloud-router-actions-search-request-filter-additional-properties (JSON) + --cloud-router-actions-search-request-filter-and string cloud-router-actions-search-request-filter-and (JSON array) + --cloud-router-actions-search-request-pagination-additional-properties string cloud-router-actions-search-request-pagination-additional-properties (JSON) + --cloud-router-actions-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --cloud-router-actions-search-request-pagination-offset int Index of the first element. + --cloud-router-actions-search-request-sort string cloud-router-actions-search-request-sort (JSON array) + -h, --help help for search-router-actions + --request string JSON payload for additional optional fields not exposed as flags + --router-id string Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_cloud-routers_update-cloud-router-by-uuid.md b/docs/equinix_fabricv4_cloud-routers_update-cloud-router-by-uuid.md new file mode 100644 index 0000000..3f0055b --- /dev/null +++ b/docs/equinix_fabricv4_cloud-routers_update-cloud-router-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 cloud-routers update-cloud-router-by-uuid + +Update Routers + +### Synopsis + +This API provides capability to update user's Cloud Routers + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 cloud-routers update-cloud-router-by-uuid [flags] +``` + +### Options + +``` + --cloud-router-change-operation string cloud-router-change-operation field (JSON or string) + -h, --help help for update-cloud-router-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --router-id string Cloud Router UUID (required) +``` + +### 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 fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources + diff --git a/docs/equinix_fabricv4_connections.md b/docs/equinix_fabricv4_connections.md new file mode 100644 index 0000000..e6573dd --- /dev/null +++ b/docs/equinix_fabricv4_connections.md @@ -0,0 +1,33 @@ +## equinix fabricv4 connections + +Manage connections resources + +### Synopsis + +Commands for managing connections resources in the API + +### Options + +``` + -h, --help help for connections +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 connections create-connection](equinix_fabricv4_connections_create-connection.md) - Create Connection +* [equinix fabricv4 connections create-connection-action](equinix_fabricv4_connections_create-connection-action.md) - Connection Actions +* [equinix fabricv4 connections delete-connection-by-uuid](equinix_fabricv4_connections_delete-connection-by-uuid.md) - Delete by ID +* [equinix fabricv4 connections get-connection-by-uuid](equinix_fabricv4_connections_get-connection-by-uuid.md) - Get Connection by ID +* [equinix fabricv4 connections search-connections](equinix_fabricv4_connections_search-connections.md) - Search connections +* [equinix fabricv4 connections update-connection-by-uuid](equinix_fabricv4_connections_update-connection-by-uuid.md) - Update by ID +* [equinix fabricv4 connections validate-connections](equinix_fabricv4_connections_validate-connections.md) - Validate Connection + diff --git a/docs/equinix_fabricv4_connections_create-connection-action.md b/docs/equinix_fabricv4_connections_create-connection-action.md new file mode 100644 index 0000000..b5ed9f0 --- /dev/null +++ b/docs/equinix_fabricv4_connections_create-connection-action.md @@ -0,0 +1,40 @@ +## equinix fabricv4 connections create-connection-action + +Connection Actions + +### Synopsis + +This API provides capability to accept/reject user's virtual connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 connections create-connection-action [flags] +``` + +### Options + +``` + --connection-action-request-additional-properties string connection-action-request-additional-properties (JSON) + --connection-action-request-data-additional-properties string connection-action-request-data-additional-properties (JSON) + --connection-action-request-data-provider-bandwidth int Authorization key bandwidth in Mbps + --connection-action-request-data-z-side string connection-action-request-data-z-side (JSON) + --connection-action-request-description string Connection rejection reason detail + --connection-action-request-type string connection-action-request-type + --connection-id string Connection Id (required) + -h, --help help for create-connection-action + --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 fabricv4 connections](equinix_fabricv4_connections.md) - Manage connections resources + diff --git a/docs/equinix_fabricv4_connections_create-connection.md b/docs/equinix_fabricv4_connections_create-connection.md new file mode 100644 index 0000000..4b1241e --- /dev/null +++ b/docs/equinix_fabricv4_connections_create-connection.md @@ -0,0 +1,75 @@ +## equinix fabricv4 connections create-connection + +Create Connection + +### Synopsis + +This API provides capability to create user's virtual connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 connections create-connection [flags] +``` + +### Options + +``` + --connection-post-request-a-side-access-point string connection-post-request-a-side-access-point (JSON) + --connection-post-request-a-side-additional-info string Any additional information, which is not part of connection metadata or configuration (JSON array) + --connection-post-request-a-side-additional-properties string connection-post-request-a-side-additional-properties (JSON) + --connection-post-request-a-side-company-profile string connection-post-request-a-side-company-profile (JSON) + --connection-post-request-a-side-internet-access string connection-post-request-a-side-internet-access (JSON) + --connection-post-request-a-side-invitation string connection-post-request-a-side-invitation (JSON) + --connection-post-request-a-side-service-token string connection-post-request-a-side-service-token (JSON) + --connection-post-request-additional-info string Connection additional information (JSON array) + --connection-post-request-additional-properties string connection-post-request-additional-properties (JSON) + --connection-post-request-bandwidth int Connection bandwidth in Mbps + --connection-post-request-end-customer-additional-properties string connection-post-request-end-customer-additional-properties (JSON) + --connection-post-request-end-customer-is-disclosed Indicate if endCustomer info should be disclosed or not + --connection-post-request-end-customer-mdm-id string connection-post-request-end-customer-mdm-id + --connection-post-request-end-customer-name string connection-post-request-end-customer-name + --connection-post-request-geo-scope string connection-post-request-geo-scope + --connection-post-request-marketplace-subscription-additional-properties string connection-post-request-marketplace-subscription-additional-properties (JSON) + --connection-post-request-marketplace-subscription-href string Marketplace Subscription URI + --connection-post-request-marketplace-subscription-type string connection-post-request-marketplace-subscription-type + --connection-post-request-marketplace-subscription-uuid string Equinix-assigned Marketplace Subscription identifier + --connection-post-request-name string Customer-provided connection name + --connection-post-request-notifications string Preferences for notifications on connection configuration or status changes (JSON array) + --connection-post-request-order-additional-properties string connection-post-request-order-additional-properties (JSON) + --connection-post-request-order-billing-tier string Billing tier for connection bandwidth + --connection-post-request-order-customer-reference-number string Customer reference number + --connection-post-request-order-order-id string Order Identification + --connection-post-request-order-order-number string Order Reference Number + --connection-post-request-order-purchase-order-number string Purchase order number + --connection-post-request-order-term-length int Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case). + --connection-post-request-project-additional-properties string connection-post-request-project-additional-properties (JSON) + --connection-post-request-project-project-id string Subscriber-assigned project ID + --connection-post-request-redundancy-additional-properties string connection-post-request-redundancy-additional-properties (JSON) + --connection-post-request-redundancy-group string Redundancy group identifier (UUID of primary connection) + --connection-post-request-redundancy-priority string connection-post-request-redundancy-priority + --connection-post-request-type string connection-post-request-type + --connection-post-request-z-side-access-point string connection-post-request-z-side-access-point (JSON) + --connection-post-request-z-side-additional-info string Any additional information, which is not part of connection metadata or configuration (JSON array) + --connection-post-request-z-side-additional-properties string connection-post-request-z-side-additional-properties (JSON) + --connection-post-request-z-side-company-profile string connection-post-request-z-side-company-profile (JSON) + --connection-post-request-z-side-internet-access string connection-post-request-z-side-internet-access (JSON) + --connection-post-request-z-side-invitation string connection-post-request-z-side-invitation (JSON) + --connection-post-request-z-side-service-token string connection-post-request-z-side-service-token (JSON) + --dry-run dry-run field + -h, --help help for create-connection + --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 fabricv4 connections](equinix_fabricv4_connections.md) - Manage connections resources + diff --git a/docs/equinix_fabricv4_connections_delete-connection-by-uuid.md b/docs/equinix_fabricv4_connections_delete-connection-by-uuid.md new file mode 100644 index 0000000..9c67139 --- /dev/null +++ b/docs/equinix_fabricv4_connections_delete-connection-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 connections delete-connection-by-uuid + +Delete by ID + +### Synopsis + +Delete Connection by ID + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 connections delete-connection-by-uuid [flags] +``` + +### Options + +``` + --connection-id string Connection UUID (required) + -h, --help help for delete-connection-by-uuid + --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 fabricv4 connections](equinix_fabricv4_connections.md) - Manage connections resources + diff --git a/docs/equinix_fabricv4_connections_get-connection-by-uuid.md b/docs/equinix_fabricv4_connections_get-connection-by-uuid.md new file mode 100644 index 0000000..1143a2d --- /dev/null +++ b/docs/equinix_fabricv4_connections_get-connection-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 connections get-connection-by-uuid + +Get Connection by ID + +### Synopsis + +The API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID) + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 connections get-connection-by-uuid [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + --direction string direction field + -h, --help help for get-connection-by-uuid + --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 fabricv4 connections](equinix_fabricv4_connections.md) - Manage connections resources + diff --git a/docs/equinix_fabricv4_connections_search-connections.md b/docs/equinix_fabricv4_connections_search-connections.md new file mode 100644 index 0000000..977e07d --- /dev/null +++ b/docs/equinix_fabricv4_connections_search-connections.md @@ -0,0 +1,44 @@ +## equinix fabricv4 connections search-connections + +Search connections + +### Synopsis + +The API provides capability to get list of user's virtual connections using search criteria, including optional filtering, pagination and sorting + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 connections search-connections [flags] +``` + +### Options + +``` + -h, --help help for search-connections + --request string JSON payload for additional optional fields not exposed as flags + --search-request-additional-properties string search-request-additional-properties (JSON) + --search-request-filter-additional-properties string search-request-filter-additional-properties (JSON) + --search-request-filter-and string search-request-filter-and (JSON array) + --search-request-filter-operator string search-request-filter-operator + --search-request-filter-or string search-request-filter-or (JSON array) + --search-request-filter-property string search-request-filter-property + --search-request-filter-values string search-request-filter-values (JSON array) + --search-request-pagination-additional-properties string search-request-pagination-additional-properties (JSON) + --search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --search-request-pagination-offset int Index of the first element. + --search-request-sort string search-request-sort (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 fabricv4 connections](equinix_fabricv4_connections.md) - Manage connections resources + diff --git a/docs/equinix_fabricv4_connections_update-connection-by-uuid.md b/docs/equinix_fabricv4_connections_update-connection-by-uuid.md new file mode 100644 index 0000000..90eb91a --- /dev/null +++ b/docs/equinix_fabricv4_connections_update-connection-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 connections update-connection-by-uuid + +Update by ID + +### Synopsis + +Update Connection by ID + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 connections update-connection-by-uuid [flags] +``` + +### Options + +``` + --connection-change-operation string connection-change-operation field (JSON or string) + --connection-id string Connection Id (required) + --dry-run dry-run field + -h, --help help for update-connection-by-uuid + --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 fabricv4 connections](equinix_fabricv4_connections.md) - Manage connections resources + diff --git a/docs/equinix_fabricv4_connections_validate-connections.md b/docs/equinix_fabricv4_connections_validate-connections.md new file mode 100644 index 0000000..966696f --- /dev/null +++ b/docs/equinix_fabricv4_connections_validate-connections.md @@ -0,0 +1,36 @@ +## equinix fabricv4 connections validate-connections + +Validate Connection + +### Synopsis + +This API provides capability to validate by auth key + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 connections validate-connections [flags] +``` + +### Options + +``` + -h, --help help for validate-connections + --request string JSON payload for additional optional fields not exposed as flags + --validate-request-additional-properties string validate-request-additional-properties (JSON) + --validate-request-filter-additional-properties string validate-request-filter-additional-properties (JSON) + --validate-request-filter-and string validate-request-filter-and (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 fabricv4 connections](equinix_fabricv4_connections.md) - Manage connections resources + diff --git a/docs/equinix_fabricv4_health.md b/docs/equinix_fabricv4_health.md new file mode 100644 index 0000000..8c54ddb --- /dev/null +++ b/docs/equinix_fabricv4_health.md @@ -0,0 +1,27 @@ +## equinix fabricv4 health + +Manage health resources + +### Synopsis + +Commands for managing health resources in the API + +### Options + +``` + -h, --help help for health +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 health get-status](equinix_fabricv4_health_get-status.md) - Get service status + diff --git a/docs/equinix_fabricv4_health_get-status.md b/docs/equinix_fabricv4_health_get-status.md new file mode 100644 index 0000000..0b47ca0 --- /dev/null +++ b/docs/equinix_fabricv4_health_get-status.md @@ -0,0 +1,33 @@ +## equinix fabricv4 health get-status + +Get service status + +### Synopsis + +GET All service health statys with an option query parameter to return all Equinix Fabric customer in which the customer has a presence. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 health get-status [flags] +``` + +### Options + +``` + -h, --help help for get-status + --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 fabricv4 health](equinix_fabricv4_health.md) - Manage health resources + diff --git a/docs/equinix_fabricv4_marketplace-subscriptions.md b/docs/equinix_fabricv4_marketplace-subscriptions.md new file mode 100644 index 0000000..0540f7b --- /dev/null +++ b/docs/equinix_fabricv4_marketplace-subscriptions.md @@ -0,0 +1,27 @@ +## equinix fabricv4 marketplace-subscriptions + +Manage marketplace-subscriptions resources + +### Synopsis + +Commands for managing marketplace-subscriptions resources in the API + +### Options + +``` + -h, --help help for marketplace-subscriptions +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 marketplace-subscriptions get-subscription-by-id](equinix_fabricv4_marketplace-subscriptions_get-subscription-by-id.md) - Get Subscription + diff --git a/docs/equinix_fabricv4_marketplace-subscriptions_get-subscription-by-id.md b/docs/equinix_fabricv4_marketplace-subscriptions_get-subscription-by-id.md new file mode 100644 index 0000000..25f5d50 --- /dev/null +++ b/docs/equinix_fabricv4_marketplace-subscriptions_get-subscription-by-id.md @@ -0,0 +1,34 @@ +## equinix fabricv4 marketplace-subscriptions get-subscription-by-id + +Get Subscription + +### Synopsis + +The API provides capability to get subscription + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 marketplace-subscriptions get-subscription-by-id [flags] +``` + +### Options + +``` + -h, --help help for get-subscription-by-id + --request string JSON payload for request body fields + --subscription-id string Subscription UUID (required) +``` + +### 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 fabricv4 marketplace-subscriptions](equinix_fabricv4_marketplace-subscriptions.md) - Manage marketplace-subscriptions resources + diff --git a/docs/equinix_fabricv4_metrics.md b/docs/equinix_fabricv4_metrics.md new file mode 100644 index 0000000..f963746 --- /dev/null +++ b/docs/equinix_fabricv4_metrics.md @@ -0,0 +1,28 @@ +## equinix fabricv4 metrics + +Manage metrics resources + +### Synopsis + +Commands for managing metrics resources in the API + +### Options + +``` + -h, --help help for metrics +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 metrics get-metric-by-asset-id](equinix_fabricv4_metrics_get-metric-by-asset-id.md) - Get Metrics by Asset Id +* [equinix fabricv4 metrics search-metrics](equinix_fabricv4_metrics_search-metrics.md) - Search Metrics + diff --git a/docs/equinix_fabricv4_metrics_get-metric-by-asset-id.md b/docs/equinix_fabricv4_metrics_get-metric-by-asset-id.md new file mode 100644 index 0000000..a57d7e8 --- /dev/null +++ b/docs/equinix_fabricv4_metrics_get-metric-by-asset-id.md @@ -0,0 +1,38 @@ +## equinix fabricv4 metrics get-metric-by-asset-id + +Get Metrics by Asset Id + +### Synopsis + +This API provides capability to retrieve Metrics of an asset id + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 metrics get-metric-by-asset-id [flags] +``` + +### Options + +``` + --asset string asset (required) + --asset-id string asset UUID (required) + -h, --help help for get-metric-by-asset-id + --limit int limit field + --name string name field + --offset int offset 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 fabricv4 metrics](equinix_fabricv4_metrics.md) - Manage metrics resources + diff --git a/docs/equinix_fabricv4_metrics_search-metrics.md b/docs/equinix_fabricv4_metrics_search-metrics.md new file mode 100644 index 0000000..13f5c19 --- /dev/null +++ b/docs/equinix_fabricv4_metrics_search-metrics.md @@ -0,0 +1,39 @@ +## equinix fabricv4 metrics search-metrics + +Search Metrics + +### Synopsis + +This API provides capability to search metrics from a filtered query + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 metrics search-metrics [flags] +``` + +### Options + +``` + -h, --help help for search-metrics + --metrics-search-request-additional-properties string metrics-search-request-additional-properties (JSON) + --metrics-search-request-filter-additional-properties string metrics-search-request-filter-additional-properties (JSON) + --metrics-search-request-filter-and string metrics-search-request-filter-and (JSON array) + --metrics-search-request-pagination-additional-properties string metrics-search-request-pagination-additional-properties (JSON) + --metrics-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --metrics-search-request-pagination-offset int Index of the first element. + --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 fabricv4 metrics](equinix_fabricv4_metrics.md) - Manage metrics resources + diff --git a/docs/equinix_fabricv4_metros.md b/docs/equinix_fabricv4_metros.md new file mode 100644 index 0000000..90ccc8d --- /dev/null +++ b/docs/equinix_fabricv4_metros.md @@ -0,0 +1,28 @@ +## equinix fabricv4 metros + +Manage metros resources + +### Synopsis + +Commands for managing metros resources in the API + +### Options + +``` + -h, --help help for metros +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 metros get-metro-by-code](equinix_fabricv4_metros_get-metro-by-code.md) - Get Metro by Code +* [equinix fabricv4 metros get-metros](equinix_fabricv4_metros_get-metros.md) - Get all Metros + diff --git a/docs/equinix_fabricv4_metros_get-metro-by-code.md b/docs/equinix_fabricv4_metros_get-metro-by-code.md new file mode 100644 index 0000000..fdfd74d --- /dev/null +++ b/docs/equinix_fabricv4_metros_get-metro-by-code.md @@ -0,0 +1,34 @@ +## equinix fabricv4 metros get-metro-by-code + +Get Metro by Code + +### Synopsis + +GET Metros retrieves all Equinix Fabric metros, as well as latency data between each metro location. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 metros get-metro-by-code [flags] +``` + +### Options + +``` + -h, --help help for get-metro-by-code + --metro-code string Metro Code (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 fabricv4 metros](equinix_fabricv4_metros.md) - Manage metros resources + diff --git a/docs/equinix_fabricv4_metros_get-metros.md b/docs/equinix_fabricv4_metros_get-metros.md new file mode 100644 index 0000000..dad2c58 --- /dev/null +++ b/docs/equinix_fabricv4_metros_get-metros.md @@ -0,0 +1,36 @@ +## equinix fabricv4 metros get-metros + +Get all Metros + +### Synopsis + +GET All Subscriber Metros with an option query parameter to return all Equinix Fabric metros in which the customer has a presence, as well as latency data for each location. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 metros get-metros [flags] +``` + +### Options + +``` + -h, --help help for get-metros + --limit int limit field + --offset int offset field + --presence string presence 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 fabricv4 metros](equinix_fabricv4_metros.md) - Manage metros resources + diff --git a/docs/equinix_fabricv4_networks.md b/docs/equinix_fabricv4_networks.md new file mode 100644 index 0000000..7bf97a5 --- /dev/null +++ b/docs/equinix_fabricv4_networks.md @@ -0,0 +1,34 @@ +## equinix fabricv4 networks + +Manage networks resources + +### Synopsis + +Commands for managing networks resources in the API + +### Options + +``` + -h, --help help for networks +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 networks create-network](equinix_fabricv4_networks_create-network.md) - Create Network +* [equinix fabricv4 networks delete-network-by-uuid](equinix_fabricv4_networks_delete-network-by-uuid.md) - Delete Network By ID +* [equinix fabricv4 networks get-connections-by-network-uuid](equinix_fabricv4_networks_get-connections-by-network-uuid.md) - Get Connections +* [equinix fabricv4 networks get-network-by-uuid](equinix_fabricv4_networks_get-network-by-uuid.md) - Get Network By ID +* [equinix fabricv4 networks get-network-change-by-uuid](equinix_fabricv4_networks_get-network-change-by-uuid.md) - Get Change By ID +* [equinix fabricv4 networks get-network-changes](equinix_fabricv4_networks_get-network-changes.md) - Get Network Changes +* [equinix fabricv4 networks search-networks](equinix_fabricv4_networks_search-networks.md) - Search Network +* [equinix fabricv4 networks update-network-by-uuid](equinix_fabricv4_networks_update-network-by-uuid.md) - Update Network By ID + diff --git a/docs/equinix_fabricv4_networks_create-network.md b/docs/equinix_fabricv4_networks_create-network.md new file mode 100644 index 0000000..aed9f96 --- /dev/null +++ b/docs/equinix_fabricv4_networks_create-network.md @@ -0,0 +1,47 @@ +## equinix fabricv4 networks create-network + +Create Network + +### Synopsis + +This API provides capability to create user's Fabric Network + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 networks create-network [flags] +``` + +### Options + +``` + --dry-run dry-run field + -h, --help help for create-network + --network-post-request-additional-properties string network-post-request-additional-properties (JSON) + --network-post-request-location-additional-properties string network-post-request-location-additional-properties (JSON) + --network-post-request-location-ibx string Deprecated + --network-post-request-location-metro-code string network-post-request-location-metro-code + --network-post-request-location-metro-href string network-post-request-location-metro-href + --network-post-request-location-metro-name string network-post-request-location-metro-name + --network-post-request-location-region string network-post-request-location-region + --network-post-request-name string Customer-provided network name + --network-post-request-notifications string Preferences for notifications on network configuration or status changes (JSON array) + --network-post-request-project-additional-properties string network-post-request-project-additional-properties (JSON) + --network-post-request-project-project-id string Subscriber-assigned project ID + --network-post-request-scope string network-post-request-scope + --network-post-request-type string network-post-request-type + --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 fabricv4 networks](equinix_fabricv4_networks.md) - Manage networks resources + diff --git a/docs/equinix_fabricv4_networks_delete-network-by-uuid.md b/docs/equinix_fabricv4_networks_delete-network-by-uuid.md new file mode 100644 index 0000000..c6a7f9b --- /dev/null +++ b/docs/equinix_fabricv4_networks_delete-network-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 networks delete-network-by-uuid + +Delete Network By ID + +### Synopsis + +This API provides capability to delete user's Fabric Network + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 networks delete-network-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-network-by-uuid + --network-id string Network 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 fabricv4 networks](equinix_fabricv4_networks.md) - Manage networks resources + diff --git a/docs/equinix_fabricv4_networks_get-connections-by-network-uuid.md b/docs/equinix_fabricv4_networks_get-connections-by-network-uuid.md new file mode 100644 index 0000000..fd3effe --- /dev/null +++ b/docs/equinix_fabricv4_networks_get-connections-by-network-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 networks get-connections-by-network-uuid + +Get Connections + +### Synopsis + +The API provides capability to get list of user's Fabric Network connections + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 networks get-connections-by-network-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-connections-by-network-uuid + --network-id string Network 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 fabricv4 networks](equinix_fabricv4_networks.md) - Manage networks resources + diff --git a/docs/equinix_fabricv4_networks_get-network-by-uuid.md b/docs/equinix_fabricv4_networks_get-network-by-uuid.md new file mode 100644 index 0000000..bd22129 --- /dev/null +++ b/docs/equinix_fabricv4_networks_get-network-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 networks get-network-by-uuid + +Get Network By ID + +### Synopsis + +This API provides capability to retrieve user's Fabric Network + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 networks get-network-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-network-by-uuid + --network-id string Network 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 fabricv4 networks](equinix_fabricv4_networks.md) - Manage networks resources + diff --git a/docs/equinix_fabricv4_networks_get-network-change-by-uuid.md b/docs/equinix_fabricv4_networks_get-network-change-by-uuid.md new file mode 100644 index 0000000..be4a328 --- /dev/null +++ b/docs/equinix_fabricv4_networks_get-network-change-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 networks get-network-change-by-uuid + +Get Change By ID + +### Synopsis + +This API provides capability to retrieve user's Fabric Network Change + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 networks get-network-change-by-uuid [flags] +``` + +### Options + +``` + --change-id string Network Change UUID (required) + -h, --help help for get-network-change-by-uuid + --network-id string Network 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 fabricv4 networks](equinix_fabricv4_networks.md) - Manage networks resources + diff --git a/docs/equinix_fabricv4_networks_get-network-changes.md b/docs/equinix_fabricv4_networks_get-network-changes.md new file mode 100644 index 0000000..2820b00 --- /dev/null +++ b/docs/equinix_fabricv4_networks_get-network-changes.md @@ -0,0 +1,34 @@ +## equinix fabricv4 networks get-network-changes + +Get Network Changes + +### Synopsis + +The API provides capability to get list of user's Fabric Network changes + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 networks get-network-changes [flags] +``` + +### Options + +``` + -h, --help help for get-network-changes + --network-id string Network 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 fabricv4 networks](equinix_fabricv4_networks.md) - Manage networks resources + diff --git a/docs/equinix_fabricv4_networks_search-networks.md b/docs/equinix_fabricv4_networks_search-networks.md new file mode 100644 index 0000000..91d6af5 --- /dev/null +++ b/docs/equinix_fabricv4_networks_search-networks.md @@ -0,0 +1,44 @@ +## equinix fabricv4 networks search-networks + +Search Network + +### Synopsis + +The API provides capability to get list of user's Fabric Network using search criteria, including optional filtering, pagination and sorting + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 networks search-networks [flags] +``` + +### Options + +``` + -h, --help help for search-networks + --network-search-request-additional-properties string network-search-request-additional-properties (JSON) + --network-search-request-filter-additional-properties string network-search-request-filter-additional-properties (JSON) + --network-search-request-filter-and string network-search-request-filter-and (JSON array) + --network-search-request-filter-operator string network-search-request-filter-operator + --network-search-request-filter-or string network-search-request-filter-or (JSON array) + --network-search-request-filter-property string network-search-request-filter-property + --network-search-request-filter-values string network-search-request-filter-values (JSON array) + --network-search-request-pagination-additional-properties string network-search-request-pagination-additional-properties (JSON) + --network-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --network-search-request-pagination-offset int Index of the first element. + --network-search-request-sort string network-search-request-sort (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 fabricv4 networks](equinix_fabricv4_networks.md) - Manage networks resources + diff --git a/docs/equinix_fabricv4_networks_update-network-by-uuid.md b/docs/equinix_fabricv4_networks_update-network-by-uuid.md new file mode 100644 index 0000000..9d48233 --- /dev/null +++ b/docs/equinix_fabricv4_networks_update-network-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 networks update-network-by-uuid + +Update Network By ID + +### Synopsis + +This API provides capability to update user's Fabric Network + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 networks update-network-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for update-network-by-uuid + --network-change-operation string network-change-operation field (JSON or string) + --network-id string Network 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 fabricv4 networks](equinix_fabricv4_networks.md) - Manage networks resources + diff --git a/docs/equinix_fabricv4_port-packages.md b/docs/equinix_fabricv4_port-packages.md new file mode 100644 index 0000000..ecef3f5 --- /dev/null +++ b/docs/equinix_fabricv4_port-packages.md @@ -0,0 +1,27 @@ +## equinix fabricv4 port-packages + +Manage port-packages resources + +### Synopsis + +Commands for managing port-packages resources in the API + +### Options + +``` + -h, --help help for port-packages +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 port-packages get-port-packages](equinix_fabricv4_port-packages_get-port-packages.md) - Get All Port Packages + diff --git a/docs/equinix_fabricv4_port-packages_get-port-packages.md b/docs/equinix_fabricv4_port-packages_get-port-packages.md new file mode 100644 index 0000000..7c9867d --- /dev/null +++ b/docs/equinix_fabricv4_port-packages_get-port-packages.md @@ -0,0 +1,33 @@ +## equinix fabricv4 port-packages get-port-packages + +Get All Port Packages + +### Synopsis + +Get All Port Packages returns details of all available port packages for the specified user credentials. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 port-packages get-port-packages [flags] +``` + +### Options + +``` + -h, --help help for get-port-packages + --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 fabricv4 port-packages](equinix_fabricv4_port-packages.md) - Manage port-packages resources + diff --git a/docs/equinix_fabricv4_ports.md b/docs/equinix_fabricv4_ports.md new file mode 100644 index 0000000..96dc650 --- /dev/null +++ b/docs/equinix_fabricv4_ports.md @@ -0,0 +1,34 @@ +## equinix fabricv4 ports + +Manage ports resources + +### Synopsis + +Commands for managing ports resources in the API + +### Options + +``` + -h, --help help for ports +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 ports add-to-lag](equinix_fabricv4_ports_add-to-lag.md) - Add to Lag +* [equinix fabricv4 ports create-port](equinix_fabricv4_ports_create-port.md) - Create Port +* [equinix fabricv4 ports delete-port](equinix_fabricv4_ports_delete-port.md) - Delete a single port +* [equinix fabricv4 ports get-port-by-uuid](equinix_fabricv4_ports_get-port-by-uuid.md) - Get Port by uuid +* [equinix fabricv4 ports get-ports](equinix_fabricv4_ports_get-ports.md) - Get All Ports +* [equinix fabricv4 ports get-vlans](equinix_fabricv4_ports_get-vlans.md) - Get Vlans +* [equinix fabricv4 ports search-ports](equinix_fabricv4_ports_search-ports.md) - Search ports +* [equinix fabricv4 ports update-port-by-uuid](equinix_fabricv4_ports_update-port-by-uuid.md) - Update by UUID + diff --git a/docs/equinix_fabricv4_ports_add-to-lag.md b/docs/equinix_fabricv4_ports_add-to-lag.md new file mode 100644 index 0000000..69b53da --- /dev/null +++ b/docs/equinix_fabricv4_ports_add-to-lag.md @@ -0,0 +1,36 @@ +## equinix fabricv4 ports add-to-lag + +Add to Lag + +### Synopsis + +Add Physical Ports to Virtual Port. Preview + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 ports add-to-lag [flags] +``` + +### Options + +``` + --bulk-physical-port-additional-properties string bulk-physical-port-additional-properties (JSON) + --bulk-physical-port-data string add physical ports to virtual port (JSON array) + -h, --help help for add-to-lag + --port-id string Port 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 fabricv4 ports](equinix_fabricv4_ports.md) - Manage ports resources + diff --git a/docs/equinix_fabricv4_ports_create-port.md b/docs/equinix_fabricv4_ports_create-port.md new file mode 100644 index 0000000..6948777 --- /dev/null +++ b/docs/equinix_fabricv4_ports_create-port.md @@ -0,0 +1,162 @@ +## equinix fabricv4 ports create-port + +Create Port + +### Synopsis + +Creates Equinix Fabric™ Port. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 ports create-port [flags] +``` + +### Options + +``` + --dry-run dry-run field + -h, --help help for create-port + --port-request-account-account-name string Account name + --port-request-account-account-number int Account number + --port-request-account-additional-properties string port-request-account-additional-properties (JSON) + --port-request-account-global-cust-id string Account name + --port-request-account-global-org-id string Global organization identifier + --port-request-account-global-organization-name string Global organization name + --port-request-account-org-id int Customer organization identifier + --port-request-account-organization-name string Customer organization name + --port-request-account-reseller-account-name string Reseller account name + --port-request-account-reseller-account-number int Reseller account number + --port-request-account-reseller-org-id int Reseller customer organization identifier + --port-request-account-reseller-ucm-id string Reseller account ucmId + --port-request-account-ucm-id string Account ucmId + --port-request-additional-info string Port additional information (JSON array) + --port-request-additional-properties string port-request-additional-properties (JSON) + --port-request-asn int Port ASN + --port-request-available-bandwidth int Equinix assigned response attribute for Port available bandwidth in Mbps + --port-request-bandwidth int Equinix assigned response attribute for Port bandwidth in Mbps + Deprecated + --port-request-bmmr-type string port-request-bmmr-type + --port-request-change-additional-properties string port-request-change-additional-properties (JSON) + --port-request-change-created-date-time string port-request-change-created-date-time (JSON) + --port-request-change-data string port-request-change-data (JSON) + --port-request-change-information string Additional information + --port-request-change-log-additional-properties string port-request-change-log-additional-properties (JSON) + --port-request-change-log-created-by string Created by User Key + --port-request-change-log-created-by-email string Created by User Email Address + --port-request-change-log-created-by-full-name string Created by User Full Name + --port-request-change-log-created-date-time string port-request-change-log-created-date-time (JSON) + --port-request-change-log-deleted-by string Deleted by User Key + --port-request-change-log-deleted-by-email string Deleted by User Email Address + --port-request-change-log-deleted-by-full-name string Deleted by User Full Name + --port-request-change-log-deleted-date-time string port-request-change-log-deleted-date-time (JSON) + --port-request-change-log-updated-by string Updated by User Key + --port-request-change-log-updated-by-email string Updated by User Email Address + --port-request-change-log-updated-by-full-name string Updated by User Full Name + --port-request-change-log-updated-date-time string port-request-change-log-updated-date-time (JSON) + --port-request-change-status string port-request-change-status + --port-request-change-type string port-request-change-type + --port-request-change-updated-date-time string port-request-change-updated-date-time (JSON) + --port-request-change-uuid string Uniquely identifies a change + --port-request-connections-count int Equinix assigned response attribute for Connection count + --port-request-connectivity-source-type string port-request-connectivity-source-type + --port-request-demarcation-point-additional-properties string port-request-demarcation-point-additional-properties (JSON) + --port-request-demarcation-point-cabinet-unique-space-id string Port cabinet unique space id + --port-request-demarcation-point-cage-unique-space-id string Port cage unique space id + --port-request-demarcation-point-connector-type string Port connector type + --port-request-demarcation-point-ibx string A-side/Equinix ibx + --port-request-demarcation-point-patch-panel string Port patch panel + --port-request-demarcation-point-patch-panel-name string Port patch panel + Deprecated + --port-request-demarcation-point-patch-panel-port-a string Port patch panel port A + --port-request-demarcation-point-patch-panel-port-b string Port patch panel port B + --port-request-description string Equinix assigned response attribute for Port description + --port-request-device-additional-properties string port-request-device-additional-properties (JSON) + --port-request-device-name string Device name + Deprecated + --port-request-device-redundancy string port-request-device-redundancy (JSON) + --port-request-device-vc-bandwidth-max int Maximum bandwidth allowed for connection. + --port-request-encapsulation-additional-properties string port-request-encapsulation-additional-properties (JSON) + --port-request-encapsulation-tag-protocol-id string Port encapsulation tag protocol identifier + --port-request-encapsulation-type string port-request-encapsulation-type + --port-request-end-customer-additional-properties string port-request-end-customer-additional-properties (JSON) + --port-request-end-customer-is-disclosed Indicate if endCustomer info should be disclosed or not + --port-request-end-customer-mdm-id string port-request-end-customer-mdm-id + --port-request-end-customer-name string port-request-end-customer-name + --port-request-href string Equinix assigned response attribute for an absolute URL that is the subject of the link's context. + --port-request-id int Equinix assigned response attribute for Port Id + --port-request-interface-additional-properties string port-request-interface-additional-properties (JSON) + --port-request-interface-type string Port interface type + --port-request-lag-additional-properties string port-request-lag-additional-properties (JSON) + --port-request-lag-enabled If LAG enabled + --port-request-lag-id string id + --port-request-lag-member-status string member status + --port-request-lag-name string name + --port-request-loas string Port Loas (JSON array) + --port-request-location-additional-properties string port-request-location-additional-properties (JSON) + --port-request-location-ibx string Deprecated + --port-request-location-metro-code string port-request-location-metro-code + --port-request-location-metro-href string port-request-location-metro-href + --port-request-location-metro-name string port-request-location-metro-name + --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-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-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) + --port-request-order-customer-reference-id string Customer order reference Id + --port-request-order-order-id string Order Identification + --port-request-order-order-number string Order Reference Number + --port-request-order-purchase-order string port-request-order-purchase-order (JSON) + --port-request-order-signature string port-request-order-signature (JSON) + --port-request-order-uuid string Equinix-assigned order identifier, this is a derived response atrribute + Deprecated + --port-request-package-additional-properties string port-request-package-additional-properties (JSON) + --port-request-package-code string port-request-package-code + --port-request-package-type string port-request-package-type + --port-request-physical-port-quantity int Number of physical ports + --port-request-physical-ports string Physical ports that implement this port (JSON array) + --port-request-physical-ports-count int port-request-physical-ports-count + --port-request-physical-ports-speed int Physical Ports Speed in Mbps + --port-request-physical-ports-type string port-request-physical-ports-type + --port-request-project-additional-properties string port-request-project-additional-properties (JSON) + --port-request-project-project-id string Subscriber-assigned project ID + --port-request-redundancy-additional-properties string port-request-redundancy-additional-properties (JSON) + --port-request-redundancy-enabled Access point redundancy + --port-request-redundancy-group string Port UUID of respective primary port + Deprecated + --port-request-redundancy-priority string port-request-redundancy-priority + --port-request-service-type string Deprecated + --port-request-settings-additional-properties string port-request-settings-additional-properties (JSON) + --port-request-settings-buyout Deprecated + --port-request-settings-layer3-enabled Deprecated + --port-request-settings-package-type string Deprecated + --port-request-settings-place-vc-order-permission Deprecated + --port-request-settings-shared-port-product string port-request-settings-shared-port-product + --port-request-settings-shared-port-type port-request-settings-shared-port-type + --port-request-settings-view-port-permission Deprecated + --port-request-state string port-request-state + --port-request-tether-ibx string z-side/Equinix ibx + --port-request-type string port-request-type + --port-request-used-bandwidth int Equinix assigned response attribute for Port used bandwidth in Mbps + --port-request-uuid string Equinix assigned response attribute for port identifier + --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 fabricv4 ports](equinix_fabricv4_ports.md) - Manage ports resources + diff --git a/docs/equinix_fabricv4_ports_delete-port.md b/docs/equinix_fabricv4_ports_delete-port.md new file mode 100644 index 0000000..0d80841 --- /dev/null +++ b/docs/equinix_fabricv4_ports_delete-port.md @@ -0,0 +1,35 @@ +## equinix fabricv4 ports delete-port + +Delete a single port + +### Synopsis + +The API provides capability to delete a single port + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 ports delete-port [flags] +``` + +### Options + +``` + --dry-run dry-run field + -h, --help help for delete-port + --port-id string Port 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 fabricv4 ports](equinix_fabricv4_ports.md) - Manage ports resources + diff --git a/docs/equinix_fabricv4_ports_get-port-by-uuid.md b/docs/equinix_fabricv4_ports_get-port-by-uuid.md new file mode 100644 index 0000000..2a3ff17 --- /dev/null +++ b/docs/equinix_fabricv4_ports_get-port-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 ports get-port-by-uuid + +Get Port by uuid + +### Synopsis + +Get Port By uuid returns details of assigned and available Equinix Fabric port for the specified user credentials. The metro code attribute in the response shows the origin of the proposed connection. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 ports get-port-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-port-by-uuid + --port-id string Port 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 fabricv4 ports](equinix_fabricv4_ports.md) - Manage ports resources + diff --git a/docs/equinix_fabricv4_ports_get-ports.md b/docs/equinix_fabricv4_ports_get-ports.md new file mode 100644 index 0000000..24c1f43 --- /dev/null +++ b/docs/equinix_fabricv4_ports_get-ports.md @@ -0,0 +1,34 @@ +## equinix fabricv4 ports get-ports + +Get All Ports + +### Synopsis + +Get All Ports returns details of all assigned and available ports for the specified user credentials. The metro attribute in the response shows the origin of the proposed connection. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 ports get-ports [flags] +``` + +### Options + +``` + -h, --help help for get-ports + --name string name 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 fabricv4 ports](equinix_fabricv4_ports.md) - Manage ports resources + diff --git a/docs/equinix_fabricv4_ports_get-vlans.md b/docs/equinix_fabricv4_ports_get-vlans.md new file mode 100644 index 0000000..4cd0a03 --- /dev/null +++ b/docs/equinix_fabricv4_ports_get-vlans.md @@ -0,0 +1,34 @@ +## equinix fabricv4 ports get-vlans + +Get Vlans + +### Synopsis + +The API provides capability to retrieve Vlans for a Port. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 ports get-vlans [flags] +``` + +### Options + +``` + -h, --help help for get-vlans + --port-uuid string Port 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 fabricv4 ports](equinix_fabricv4_ports.md) - Manage ports resources + diff --git a/docs/equinix_fabricv4_ports_search-ports.md b/docs/equinix_fabricv4_ports_search-ports.md new file mode 100644 index 0000000..ab9eabe --- /dev/null +++ b/docs/equinix_fabricv4_ports_search-ports.md @@ -0,0 +1,44 @@ +## equinix fabricv4 ports search-ports + +Search ports + +### Synopsis + +The API provides capability to get list of user's virtual ports using search criteria, including optional filtering, pagination and sorting + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 ports search-ports [flags] +``` + +### Options + +``` + -h, --help help for search-ports + --port-v4-search-request-additional-properties string port-v4-search-request-additional-properties (JSON) + --port-v4-search-request-filter-additional-properties string port-v4-search-request-filter-additional-properties (JSON) + --port-v4-search-request-filter-and string port-v4-search-request-filter-and (JSON array) + --port-v4-search-request-filter-operator string port-v4-search-request-filter-operator + --port-v4-search-request-filter-or string port-v4-search-request-filter-or (JSON array) + --port-v4-search-request-filter-property string port-v4-search-request-filter-property + --port-v4-search-request-filter-values string port-v4-search-request-filter-values (JSON array) + --port-v4-search-request-pagination-additional-properties string port-v4-search-request-pagination-additional-properties (JSON) + --port-v4-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --port-v4-search-request-pagination-offset int Index of the first element. + --port-v4-search-request-sort string port-v4-search-request-sort (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 fabricv4 ports](equinix_fabricv4_ports.md) - Manage ports resources + diff --git a/docs/equinix_fabricv4_ports_update-port-by-uuid.md b/docs/equinix_fabricv4_ports_update-port-by-uuid.md new file mode 100644 index 0000000..6341f57 --- /dev/null +++ b/docs/equinix_fabricv4_ports_update-port-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 ports update-port-by-uuid + +Update by UUID + +### Synopsis + +Update Port by UUID + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 ports update-port-by-uuid [flags] +``` + +### Options + +``` + --dry-run dry-run field + -h, --help help for update-port-by-uuid + --port-change-operation string port-change-operation field (JSON or string) + --port-id string Port 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 fabricv4 ports](equinix_fabricv4_ports.md) - Manage ports resources + diff --git a/docs/equinix_fabricv4_precision-time.md b/docs/equinix_fabricv4_precision-time.md new file mode 100644 index 0000000..cff953e --- /dev/null +++ b/docs/equinix_fabricv4_precision-time.md @@ -0,0 +1,35 @@ +## equinix fabricv4 precision-time + +Manage precision-time resources + +### Synopsis + +Commands for managing precision-time resources in the API + +### Options + +``` + -h, --help help for precision-time +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 precision-time create-time-services](equinix_fabricv4_precision-time_create-time-services.md) - Create Time Service +* [equinix fabricv4 precision-time delete-time-service-by-id](equinix_fabricv4_precision-time_delete-time-service-by-id.md) - Delete by ID. +* [equinix fabricv4 precision-time fulfill-time-services](equinix_fabricv4_precision-time_fulfill-time-services.md) - Configure Service. +* [equinix fabricv4 precision-time get-time-services-by-id](equinix_fabricv4_precision-time_get-time-services-by-id.md) - Get Service By ID. +* [equinix fabricv4 precision-time get-time-services-connections-by-service-id](equinix_fabricv4_precision-time_get-time-services-connections-by-service-id.md) - Get Connection Links +* [equinix fabricv4 precision-time get-time-services-package-by-code](equinix_fabricv4_precision-time_get-time-services-package-by-code.md) - Get Package By Code +* [equinix fabricv4 precision-time get-time-services-packages](equinix_fabricv4_precision-time_get-time-services-packages.md) - Get Packages +* [equinix fabricv4 precision-time search-time-services](equinix_fabricv4_precision-time_search-time-services.md) - Search Time Services +* [equinix fabricv4 precision-time update-time-services-by-id](equinix_fabricv4_precision-time_update-time-services-by-id.md) - Update By ID. + diff --git a/docs/equinix_fabricv4_precision-time_create-time-services.md b/docs/equinix_fabricv4_precision-time_create-time-services.md new file mode 100644 index 0000000..fc7a876 --- /dev/null +++ b/docs/equinix_fabricv4_precision-time_create-time-services.md @@ -0,0 +1,61 @@ +## equinix fabricv4 precision-time create-time-services + +Create Time Service + +### Synopsis + +The API provides capability to create Precision Time service + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 precision-time create-time-services [flags] +``` + +### Options + +``` + -h, --help help for create-time-services + --precision-time-service-request-additional-properties string precision-time-service-request-additional-properties (JSON) + --precision-time-service-request-connections string precision-time-service-request-connections (JSON array) + --precision-time-service-request-ipv4-additional-properties string precision-time-service-request-ipv4-additional-properties (JSON) + --precision-time-service-request-ipv4-default-gateway string Gateway Interface IP address + --precision-time-service-request-ipv4-network-mask string Network Mask + --precision-time-service-request-ipv4-primary string Primary Timing Server IP Address + --precision-time-service-request-ipv4-secondary string Secondary Timing Server IP Address + --precision-time-service-request-name string Precision Time Service name. + --precision-time-service-request-ntp-advanced-configuration string NTP Advanced configuration - MD5 Authentication. (JSON array) + --precision-time-service-request-order-additional-properties string precision-time-service-request-order-additional-properties (JSON) + --precision-time-service-request-order-customer-reference-number string Customer reference number + --precision-time-service-request-order-order-number string Order Reference Number + --precision-time-service-request-order-purchase-order-number string Purchase order number + --precision-time-service-request-package-additional-properties string precision-time-service-request-package-additional-properties (JSON) + --precision-time-service-request-package-code string precision-time-service-request-package-code + --precision-time-service-request-project-additional-properties string precision-time-service-request-project-additional-properties (JSON) + --precision-time-service-request-project-project-id string Subscriber-assigned project ID + --precision-time-service-request-ptp-advanced-configuration-additional-properties string precision-time-service-request-ptp-advanced-configuration-additional-properties (JSON) + --precision-time-service-request-ptp-advanced-configuration-domain int The PTP domain value. + --precision-time-service-request-ptp-advanced-configuration-grant-time int Unicast Grant Time in seconds. For Multicast and Hybrid transport modes, grant time defaults to 300 seconds. For Unicast mode, grant time can be between 30 to 7200. + --precision-time-service-request-ptp-advanced-configuration-log-announce-interval int precision-time-service-request-ptp-advanced-configuration-log-announce-interval + --precision-time-service-request-ptp-advanced-configuration-log-delay-req-interval int precision-time-service-request-ptp-advanced-configuration-log-delay-req-interval + --precision-time-service-request-ptp-advanced-configuration-log-sync-interval int precision-time-service-request-ptp-advanced-configuration-log-sync-interval + --precision-time-service-request-ptp-advanced-configuration-priority1 int The priority1 value determines the best primary clock, Lower value indicates higher priority. + --precision-time-service-request-ptp-advanced-configuration-priority2 int The priority2 value differentiates and prioritizes the primary clock to avoid confusion when priority1-value is the same for different primary clocks in a network. + --precision-time-service-request-ptp-advanced-configuration-time-scale string precision-time-service-request-ptp-advanced-configuration-time-scale + --precision-time-service-request-ptp-advanced-configuration-transport-mode string precision-time-service-request-ptp-advanced-configuration-transport-mode + --precision-time-service-request-type string precision-time-service-request-type + --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 fabricv4 precision-time](equinix_fabricv4_precision-time.md) - Manage precision-time resources + diff --git a/docs/equinix_fabricv4_precision-time_delete-time-service-by-id.md b/docs/equinix_fabricv4_precision-time_delete-time-service-by-id.md new file mode 100644 index 0000000..6a60ca0 --- /dev/null +++ b/docs/equinix_fabricv4_precision-time_delete-time-service-by-id.md @@ -0,0 +1,34 @@ +## equinix fabricv4 precision-time delete-time-service-by-id + +Delete by ID. + +### Synopsis + +The API provides capability to delete Precision Time Service by service id. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 precision-time delete-time-service-by-id [flags] +``` + +### Options + +``` + -h, --help help for delete-time-service-by-id + --request string JSON payload for request body fields + --service-id string Service UUID (required) +``` + +### 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 fabricv4 precision-time](equinix_fabricv4_precision-time.md) - Manage precision-time resources + diff --git a/docs/equinix_fabricv4_precision-time_fulfill-time-services.md b/docs/equinix_fabricv4_precision-time_fulfill-time-services.md new file mode 100644 index 0000000..8092e92 --- /dev/null +++ b/docs/equinix_fabricv4_precision-time_fulfill-time-services.md @@ -0,0 +1,62 @@ +## equinix fabricv4 precision-time fulfill-time-services + +Configure Service. + +### Synopsis + +The API provides capability to Configure/Fulfill the Precision Time Service. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 precision-time fulfill-time-services [flags] +``` + +### Options + +``` + -h, --help help for fulfill-time-services + --precision-time-service-request-additional-properties string precision-time-service-request-additional-properties (JSON) + --precision-time-service-request-connections string precision-time-service-request-connections (JSON array) + --precision-time-service-request-ipv4-additional-properties string precision-time-service-request-ipv4-additional-properties (JSON) + --precision-time-service-request-ipv4-default-gateway string Gateway Interface IP address + --precision-time-service-request-ipv4-network-mask string Network Mask + --precision-time-service-request-ipv4-primary string Primary Timing Server IP Address + --precision-time-service-request-ipv4-secondary string Secondary Timing Server IP Address + --precision-time-service-request-name string Precision Time Service name. + --precision-time-service-request-ntp-advanced-configuration string NTP Advanced configuration - MD5 Authentication. (JSON array) + --precision-time-service-request-order-additional-properties string precision-time-service-request-order-additional-properties (JSON) + --precision-time-service-request-order-customer-reference-number string Customer reference number + --precision-time-service-request-order-order-number string Order Reference Number + --precision-time-service-request-order-purchase-order-number string Purchase order number + --precision-time-service-request-package-additional-properties string precision-time-service-request-package-additional-properties (JSON) + --precision-time-service-request-package-code string precision-time-service-request-package-code + --precision-time-service-request-project-additional-properties string precision-time-service-request-project-additional-properties (JSON) + --precision-time-service-request-project-project-id string Subscriber-assigned project ID + --precision-time-service-request-ptp-advanced-configuration-additional-properties string precision-time-service-request-ptp-advanced-configuration-additional-properties (JSON) + --precision-time-service-request-ptp-advanced-configuration-domain int The PTP domain value. + --precision-time-service-request-ptp-advanced-configuration-grant-time int Unicast Grant Time in seconds. For Multicast and Hybrid transport modes, grant time defaults to 300 seconds. For Unicast mode, grant time can be between 30 to 7200. + --precision-time-service-request-ptp-advanced-configuration-log-announce-interval int precision-time-service-request-ptp-advanced-configuration-log-announce-interval + --precision-time-service-request-ptp-advanced-configuration-log-delay-req-interval int precision-time-service-request-ptp-advanced-configuration-log-delay-req-interval + --precision-time-service-request-ptp-advanced-configuration-log-sync-interval int precision-time-service-request-ptp-advanced-configuration-log-sync-interval + --precision-time-service-request-ptp-advanced-configuration-priority1 int The priority1 value determines the best primary clock, Lower value indicates higher priority. + --precision-time-service-request-ptp-advanced-configuration-priority2 int The priority2 value differentiates and prioritizes the primary clock to avoid confusion when priority1-value is the same for different primary clocks in a network. + --precision-time-service-request-ptp-advanced-configuration-time-scale string precision-time-service-request-ptp-advanced-configuration-time-scale + --precision-time-service-request-ptp-advanced-configuration-transport-mode string precision-time-service-request-ptp-advanced-configuration-transport-mode + --precision-time-service-request-type string precision-time-service-request-type + --request string JSON payload for additional optional fields not exposed as flags + --service-id string Service UUID (required) +``` + +### 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 fabricv4 precision-time](equinix_fabricv4_precision-time.md) - Manage precision-time resources + diff --git a/docs/equinix_fabricv4_precision-time_get-time-services-by-id.md b/docs/equinix_fabricv4_precision-time_get-time-services-by-id.md new file mode 100644 index 0000000..3e99e88 --- /dev/null +++ b/docs/equinix_fabricv4_precision-time_get-time-services-by-id.md @@ -0,0 +1,34 @@ +## equinix fabricv4 precision-time get-time-services-by-id + +Get Service By ID. + +### Synopsis + +The API provides capability to get Precision Time Service details + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 precision-time get-time-services-by-id [flags] +``` + +### Options + +``` + -h, --help help for get-time-services-by-id + --request string JSON payload for request body fields + --service-id string Service UUID (required) +``` + +### 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 fabricv4 precision-time](equinix_fabricv4_precision-time.md) - Manage precision-time resources + diff --git a/docs/equinix_fabricv4_precision-time_get-time-services-connections-by-service-id.md b/docs/equinix_fabricv4_precision-time_get-time-services-connections-by-service-id.md new file mode 100644 index 0000000..053792e --- /dev/null +++ b/docs/equinix_fabricv4_precision-time_get-time-services-connections-by-service-id.md @@ -0,0 +1,34 @@ +## equinix fabricv4 precision-time get-time-services-connections-by-service-id + +Get Connection Links + +### Synopsis + +The API provides capability to get prevision timing service's details + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 precision-time get-time-services-connections-by-service-id [flags] +``` + +### Options + +``` + -h, --help help for get-time-services-connections-by-service-id + --request string JSON payload for request body fields + --service-id string Service UUID (required) +``` + +### 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 fabricv4 precision-time](equinix_fabricv4_precision-time.md) - Manage precision-time resources + diff --git a/docs/equinix_fabricv4_precision-time_get-time-services-package-by-code.md b/docs/equinix_fabricv4_precision-time_get-time-services-package-by-code.md new file mode 100644 index 0000000..c75ba48 --- /dev/null +++ b/docs/equinix_fabricv4_precision-time_get-time-services-package-by-code.md @@ -0,0 +1,34 @@ +## equinix fabricv4 precision-time get-time-services-package-by-code + +Get Package By Code + +### Synopsis + +The API provides capability to get timing service's package by code + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 precision-time get-time-services-package-by-code [flags] +``` + +### Options + +``` + -h, --help help for get-time-services-package-by-code + --package-code string Package Code (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 fabricv4 precision-time](equinix_fabricv4_precision-time.md) - Manage precision-time resources + diff --git a/docs/equinix_fabricv4_precision-time_get-time-services-packages.md b/docs/equinix_fabricv4_precision-time_get-time-services-packages.md new file mode 100644 index 0000000..60f77c8 --- /dev/null +++ b/docs/equinix_fabricv4_precision-time_get-time-services-packages.md @@ -0,0 +1,33 @@ +## equinix fabricv4 precision-time get-time-services-packages + +Get Packages + +### Synopsis + +The API provides capability to get timing service's packages + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 precision-time get-time-services-packages [flags] +``` + +### Options + +``` + -h, --help help for get-time-services-packages + --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 fabricv4 precision-time](equinix_fabricv4_precision-time.md) - Manage precision-time resources + diff --git a/docs/equinix_fabricv4_precision-time_search-time-services.md b/docs/equinix_fabricv4_precision-time_search-time-services.md new file mode 100644 index 0000000..efeab28 --- /dev/null +++ b/docs/equinix_fabricv4_precision-time_search-time-services.md @@ -0,0 +1,40 @@ +## equinix fabricv4 precision-time search-time-services + +Search Time Services + +### Synopsis + +The API provides capability to get list of user's Time Services using search criteria, including optional filtering, pagination and sorting + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 precision-time search-time-services [flags] +``` + +### Options + +``` + -h, --help help for search-time-services + --request string JSON payload for additional optional fields not exposed as flags + --time-services-search-request-additional-properties string time-services-search-request-additional-properties (JSON) + --time-services-search-request-filter-additional-properties string time-services-search-request-filter-additional-properties (JSON) + --time-services-search-request-filter-and string time-services-search-request-filter-and (JSON array) + --time-services-search-request-pagination-additional-properties string time-services-search-request-pagination-additional-properties (JSON) + --time-services-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --time-services-search-request-pagination-offset int Index of the first element. + --time-services-search-request-sort string time-services-search-request-sort (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 fabricv4 precision-time](equinix_fabricv4_precision-time.md) - Manage precision-time resources + diff --git a/docs/equinix_fabricv4_precision-time_update-time-services-by-id.md b/docs/equinix_fabricv4_precision-time_update-time-services-by-id.md new file mode 100644 index 0000000..ef00656 --- /dev/null +++ b/docs/equinix_fabricv4_precision-time_update-time-services-by-id.md @@ -0,0 +1,35 @@ +## equinix fabricv4 precision-time update-time-services-by-id + +Update By ID. + +### Synopsis + +The API provides capability to update Precision Time Service by service id. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 precision-time update-time-services-by-id [flags] +``` + +### Options + +``` + -h, --help help for update-time-services-by-id + --precision-time-change-operation string precision-time-change-operation field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --service-id string Service UUID (required) +``` + +### 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 fabricv4 precision-time](equinix_fabricv4_precision-time.md) - Manage precision-time resources + diff --git a/docs/equinix_fabricv4_prices.md b/docs/equinix_fabricv4_prices.md new file mode 100644 index 0000000..24b753c --- /dev/null +++ b/docs/equinix_fabricv4_prices.md @@ -0,0 +1,27 @@ +## equinix fabricv4 prices + +Manage prices resources + +### Synopsis + +Commands for managing prices resources in the API + +### Options + +``` + -h, --help help for prices +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 prices search-prices](equinix_fabricv4_prices_search-prices.md) - Get Prices + diff --git a/docs/equinix_fabricv4_prices_search-prices.md b/docs/equinix_fabricv4_prices_search-prices.md new file mode 100644 index 0000000..03c929d --- /dev/null +++ b/docs/equinix_fabricv4_prices_search-prices.md @@ -0,0 +1,40 @@ +## equinix fabricv4 prices search-prices + +Get Prices + +### Synopsis + +Search prices by search criteria + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 prices search-prices [flags] +``` + +### Options + +``` + --filter-body-additional-properties string filter-body-additional-properties (JSON) + --filter-body-filter-additional-properties string filter-body-filter-additional-properties (JSON) + --filter-body-filter-and string filter-body-filter-and (JSON array) + --filter-body-filter-operator string filter-body-filter-operator + --filter-body-filter-or string filter-body-filter-or (JSON array) + --filter-body-filter-property string filter-body-filter-property + --filter-body-filter-values string filter-body-filter-values (JSON array) + -h, --help help for search-prices + --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 fabricv4 prices](equinix_fabricv4_prices.md) - Manage prices resources + diff --git a/docs/equinix_fabricv4_route-aggregation-rules.md b/docs/equinix_fabricv4_route-aggregation-rules.md new file mode 100644 index 0000000..2fd61a7 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregation-rules.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-aggregation-rules + +Manage route-aggregation-rules resources + +### Synopsis + +Commands for managing route-aggregation-rules resources in the API + +### Options + +``` + -h, --help help for route-aggregation-rules +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 route-aggregation-rules create-route-aggregation-rule](equinix_fabricv4_route-aggregation-rules_create-route-aggregation-rule.md) - Create RARule +* [equinix fabricv4 route-aggregation-rules create-route-aggregation-rules-in-bulk](equinix_fabricv4_route-aggregation-rules_create-route-aggregation-rules-in-bulk.md) - Bulk RARules +* [equinix fabricv4 route-aggregation-rules delete-route-aggregation-rule-by-uuid](equinix_fabricv4_route-aggregation-rules_delete-route-aggregation-rule-by-uuid.md) - DeleteRARule +* [equinix fabricv4 route-aggregation-rules get-route-aggregation-rule-by-uuid](equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-by-uuid.md) - GetRARule By UUID +* [equinix fabricv4 route-aggregation-rules get-route-aggregation-rule-change-by-uuid](equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-change-by-uuid.md) - Get Change By ID +* [equinix fabricv4 route-aggregation-rules get-route-aggregation-rule-changes](equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-changes.md) - Get All Changes +* [equinix fabricv4 route-aggregation-rules get-route-aggregation-rules](equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rules.md) - GetRARules +* [equinix fabricv4 route-aggregation-rules patch-route-aggregation-rule-by-uuid](equinix_fabricv4_route-aggregation-rules_patch-route-aggregation-rule-by-uuid.md) - PatchRARule +* [equinix fabricv4 route-aggregation-rules replace-route-aggregation-rule-by-uuid](equinix_fabricv4_route-aggregation-rules_replace-route-aggregation-rule-by-uuid.md) - ReplaceRARule + diff --git a/docs/equinix_fabricv4_route-aggregation-rules_create-route-aggregation-rule.md b/docs/equinix_fabricv4_route-aggregation-rules_create-route-aggregation-rule.md new file mode 100644 index 0000000..a3cf175 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregation-rules_create-route-aggregation-rule.md @@ -0,0 +1,38 @@ +## equinix fabricv4 route-aggregation-rules create-route-aggregation-rule + +Create RARule + +### Synopsis + +This API provides capability to create a Route Aggregation Rule + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregation-rules create-route-aggregation-rule [flags] +``` + +### Options + +``` + -h, --help help for create-route-aggregation-rule + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregation-id string Route Aggregations Id (required) + --route-aggregation-rules-base-additional-properties string route-aggregation-rules-base-additional-properties (JSON) + --route-aggregation-rules-base-description string Customer-provided Route Aggregation Rule description + --route-aggregation-rules-base-name string route-aggregation-rules-base-name + --route-aggregation-rules-base-prefix string route-aggregation-rules-base-prefix +``` + +### 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 fabricv4 route-aggregation-rules](equinix_fabricv4_route-aggregation-rules.md) - Manage route-aggregation-rules resources + diff --git a/docs/equinix_fabricv4_route-aggregation-rules_create-route-aggregation-rules-in-bulk.md b/docs/equinix_fabricv4_route-aggregation-rules_create-route-aggregation-rules-in-bulk.md new file mode 100644 index 0000000..ed49717 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregation-rules_create-route-aggregation-rules-in-bulk.md @@ -0,0 +1,36 @@ +## equinix fabricv4 route-aggregation-rules create-route-aggregation-rules-in-bulk + +Bulk RARules + +### Synopsis + +This API provides capability to create bulk route aggregation rules + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregation-rules create-route-aggregation-rules-in-bulk [flags] +``` + +### Options + +``` + -h, --help help for create-route-aggregation-rules-in-bulk + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregation-id string Route Aggregations Id (required) + --route-aggregation-rules-post-request-additional-properties string route-aggregation-rules-post-request-additional-properties (JSON) + --route-aggregation-rules-post-request-data string Route Aggregation Rule configuration (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 fabricv4 route-aggregation-rules](equinix_fabricv4_route-aggregation-rules.md) - Manage route-aggregation-rules resources + diff --git a/docs/equinix_fabricv4_route-aggregation-rules_delete-route-aggregation-rule-by-uuid.md b/docs/equinix_fabricv4_route-aggregation-rules_delete-route-aggregation-rule-by-uuid.md new file mode 100644 index 0000000..a08a868 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregation-rules_delete-route-aggregation-rule-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-aggregation-rules delete-route-aggregation-rule-by-uuid + +DeleteRARule + +### Synopsis + +This API provides capability to delete a Route aggregation Rule + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregation-rules delete-route-aggregation-rule-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-route-aggregation-rule-by-uuid + --request string JSON payload for request body fields + --route-aggregation-id string Route Aggregations Id (required) + --route-aggregation-rule-id string Route Aggregation Rules Id (required) +``` + +### 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 fabricv4 route-aggregation-rules](equinix_fabricv4_route-aggregation-rules.md) - Manage route-aggregation-rules resources + diff --git a/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-by-uuid.md b/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-by-uuid.md new file mode 100644 index 0000000..6a809d3 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-aggregation-rules get-route-aggregation-rule-by-uuid + +GetRARule By UUID + +### Synopsis + +This API provides capability to view a Route Aggregation Rule by UUID + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregation-rules get-route-aggregation-rule-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-route-aggregation-rule-by-uuid + --request string JSON payload for request body fields + --route-aggregation-id string Route Aggregations Id (required) + --route-aggregation-rule-id string Route Aggregation Rules Id (required) +``` + +### 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 fabricv4 route-aggregation-rules](equinix_fabricv4_route-aggregation-rules.md) - Manage route-aggregation-rules resources + diff --git a/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-change-by-uuid.md b/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-change-by-uuid.md new file mode 100644 index 0000000..febda9b --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-change-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 route-aggregation-rules get-route-aggregation-rule-change-by-uuid + +Get Change By ID + +### Synopsis + +This API provides capability to retrieve a specific Route Aggregation Rule's Changes + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregation-rules get-route-aggregation-rule-change-by-uuid [flags] +``` + +### Options + +``` + --change-id string Route Aggregation Rule Change UUID (required) + -h, --help help for get-route-aggregation-rule-change-by-uuid + --request string JSON payload for request body fields + --route-aggregation-id string Route Aggregations Id (required) + --route-aggregation-rule-id string Route Aggregation Rules Id (required) +``` + +### 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 fabricv4 route-aggregation-rules](equinix_fabricv4_route-aggregation-rules.md) - Manage route-aggregation-rules resources + diff --git a/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-changes.md b/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-changes.md new file mode 100644 index 0000000..7bb9d11 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rule-changes.md @@ -0,0 +1,37 @@ +## equinix fabricv4 route-aggregation-rules get-route-aggregation-rule-changes + +Get All Changes + +### Synopsis + +This API provides capability to retrieve all of a Route Aggregation Rule's Changes + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregation-rules get-route-aggregation-rule-changes [flags] +``` + +### Options + +``` + -h, --help help for get-route-aggregation-rule-changes + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregation-id string Route Aggregations Id (required) + --route-aggregation-rule-id string Route Aggregation Rules Id (required) +``` + +### 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 fabricv4 route-aggregation-rules](equinix_fabricv4_route-aggregation-rules.md) - Manage route-aggregation-rules resources + diff --git a/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rules.md b/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rules.md new file mode 100644 index 0000000..a1dcd10 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rules.md @@ -0,0 +1,36 @@ +## equinix fabricv4 route-aggregation-rules get-route-aggregation-rules + +GetRARules + +### Synopsis + +This API provides capability to get all Route Aggregations Rules for Fabric + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregation-rules get-route-aggregation-rules [flags] +``` + +### Options + +``` + -h, --help help for get-route-aggregation-rules + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregation-id string Route Aggregations Id (required) +``` + +### 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 fabricv4 route-aggregation-rules](equinix_fabricv4_route-aggregation-rules.md) - Manage route-aggregation-rules resources + diff --git a/docs/equinix_fabricv4_route-aggregation-rules_patch-route-aggregation-rule-by-uuid.md b/docs/equinix_fabricv4_route-aggregation-rules_patch-route-aggregation-rule-by-uuid.md new file mode 100644 index 0000000..a1fc4eb --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregation-rules_patch-route-aggregation-rule-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 route-aggregation-rules patch-route-aggregation-rule-by-uuid + +PatchRARule + +### Synopsis + +This API provides capability to partially update a Route Aggregation Rule + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregation-rules patch-route-aggregation-rule-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for patch-route-aggregation-rule-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregation-id string Route Aggregations Id (required) + --route-aggregation-rule-id string Route Aggregation Rules Id (required) + --route-aggregation-rules-patch-request-item string route-aggregation-rules-patch-request-item field (JSON or string) +``` + +### 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 fabricv4 route-aggregation-rules](equinix_fabricv4_route-aggregation-rules.md) - Manage route-aggregation-rules resources + diff --git a/docs/equinix_fabricv4_route-aggregation-rules_replace-route-aggregation-rule-by-uuid.md b/docs/equinix_fabricv4_route-aggregation-rules_replace-route-aggregation-rule-by-uuid.md new file mode 100644 index 0000000..5832e01 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregation-rules_replace-route-aggregation-rule-by-uuid.md @@ -0,0 +1,39 @@ +## equinix fabricv4 route-aggregation-rules replace-route-aggregation-rule-by-uuid + +ReplaceRARule + +### Synopsis + +This API provides capability to replace a Route Aggregation Rule completely + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregation-rules replace-route-aggregation-rule-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for replace-route-aggregation-rule-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregation-id string Route Aggregations Id (required) + --route-aggregation-rule-id string Route Aggregation Rules Id (required) + --route-aggregation-rules-base-additional-properties string route-aggregation-rules-base-additional-properties (JSON) + --route-aggregation-rules-base-description string Customer-provided Route Aggregation Rule description + --route-aggregation-rules-base-name string route-aggregation-rules-base-name + --route-aggregation-rules-base-prefix string route-aggregation-rules-base-prefix +``` + +### 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 fabricv4 route-aggregation-rules](equinix_fabricv4_route-aggregation-rules.md) - Manage route-aggregation-rules resources + diff --git a/docs/equinix_fabricv4_route-aggregations.md b/docs/equinix_fabricv4_route-aggregations.md new file mode 100644 index 0000000..45e3ada --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations.md @@ -0,0 +1,38 @@ +## equinix fabricv4 route-aggregations + +Manage route-aggregations resources + +### Synopsis + +Commands for managing route-aggregations resources in the API + +### Options + +``` + -h, --help help for route-aggregations +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 route-aggregations attach-connection-route-aggregation](equinix_fabricv4_route-aggregations_attach-connection-route-aggregation.md) - Attach Aggregation +* [equinix fabricv4 route-aggregations create-route-aggregation](equinix_fabricv4_route-aggregations_create-route-aggregation.md) - Create Aggregations +* [equinix fabricv4 route-aggregations delete-route-aggregation-by-uuid](equinix_fabricv4_route-aggregations_delete-route-aggregation-by-uuid.md) - Delete Aggregation +* [equinix fabricv4 route-aggregations detach-connection-route-aggregation](equinix_fabricv4_route-aggregations_detach-connection-route-aggregation.md) - Detach Aggregation +* [equinix fabricv4 route-aggregations get-connection-route-aggregation-by-uuid](equinix_fabricv4_route-aggregations_get-connection-route-aggregation-by-uuid.md) - Get Aggregation +* [equinix fabricv4 route-aggregations get-connection-route-aggregations](equinix_fabricv4_route-aggregations_get-connection-route-aggregations.md) - Get All Aggregations +* [equinix fabricv4 route-aggregations get-route-aggregation-by-uuid](equinix_fabricv4_route-aggregations_get-route-aggregation-by-uuid.md) - Get Aggregation +* [equinix fabricv4 route-aggregations get-route-aggregation-change-by-uuid](equinix_fabricv4_route-aggregations_get-route-aggregation-change-by-uuid.md) - Get Change By ID +* [equinix fabricv4 route-aggregations get-route-aggregation-changes](equinix_fabricv4_route-aggregations_get-route-aggregation-changes.md) - Get All Changes +* [equinix fabricv4 route-aggregations get-route-aggregation-connections](equinix_fabricv4_route-aggregations_get-route-aggregation-connections.md) - Get All Connections on Route Aggregation +* [equinix fabricv4 route-aggregations patch-route-aggregation-by-uuid](equinix_fabricv4_route-aggregations_patch-route-aggregation-by-uuid.md) - Patch Aggregation +* [equinix fabricv4 route-aggregations search-route-aggregations](equinix_fabricv4_route-aggregations_search-route-aggregations.md) - Search Aggregations + diff --git a/docs/equinix_fabricv4_route-aggregations_attach-connection-route-aggregation.md b/docs/equinix_fabricv4_route-aggregations_attach-connection-route-aggregation.md new file mode 100644 index 0000000..172bbdd --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_attach-connection-route-aggregation.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-aggregations attach-connection-route-aggregation + +Attach Aggregation + +### Synopsis + +This API provides capability to attach a Route Aggregation to a Connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations attach-connection-route-aggregation [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for attach-connection-route-aggregation + --request string JSON payload for request body fields + --route-aggregation-id string Route Aggregations Id (required) +``` + +### 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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_create-route-aggregation.md b/docs/equinix_fabricv4_route-aggregations_create-route-aggregation.md new file mode 100644 index 0000000..69c9870 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_create-route-aggregation.md @@ -0,0 +1,39 @@ +## equinix fabricv4 route-aggregations create-route-aggregation + +Create Aggregations + +### Synopsis + +This API provides capability to create a Route Aggregation + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations create-route-aggregation [flags] +``` + +### Options + +``` + -h, --help help for create-route-aggregation + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregations-base-additional-properties string route-aggregations-base-additional-properties (JSON) + --route-aggregations-base-description string Customer-provided connection description + --route-aggregations-base-name string route-aggregations-base-name + --route-aggregations-base-project-additional-properties string route-aggregations-base-project-additional-properties (JSON) + --route-aggregations-base-project-project-id string Subscriber-assigned project ID + --route-aggregations-base-type string route-aggregations-base-type +``` + +### 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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_delete-route-aggregation-by-uuid.md b/docs/equinix_fabricv4_route-aggregations_delete-route-aggregation-by-uuid.md new file mode 100644 index 0000000..58df116 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_delete-route-aggregation-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 route-aggregations delete-route-aggregation-by-uuid + +Delete Aggregation + +### Synopsis + +This API provides capability to delete a Route Aggregation + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations delete-route-aggregation-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-route-aggregation-by-uuid + --request string JSON payload for request body fields + --route-aggregation-id string Route Aggregations Id (required) +``` + +### 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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_detach-connection-route-aggregation.md b/docs/equinix_fabricv4_route-aggregations_detach-connection-route-aggregation.md new file mode 100644 index 0000000..2ec56d9 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_detach-connection-route-aggregation.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-aggregations detach-connection-route-aggregation + +Detach Aggregation + +### Synopsis + +This API provides capability to detach a Route Aggregation from a Connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations detach-connection-route-aggregation [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for detach-connection-route-aggregation + --request string JSON payload for request body fields + --route-aggregation-id string Route Aggregations Id (required) +``` + +### 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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_get-connection-route-aggregation-by-uuid.md b/docs/equinix_fabricv4_route-aggregations_get-connection-route-aggregation-by-uuid.md new file mode 100644 index 0000000..265f0c6 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_get-connection-route-aggregation-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-aggregations get-connection-route-aggregation-by-uuid + +Get Aggregation + +### Synopsis + +This API provides capability to view a specific Route Aggregation attached to a Connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations get-connection-route-aggregation-by-uuid [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for get-connection-route-aggregation-by-uuid + --request string JSON payload for request body fields + --route-aggregation-id string Route Aggregations Id (required) +``` + +### 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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_get-connection-route-aggregations.md b/docs/equinix_fabricv4_route-aggregations_get-connection-route-aggregations.md new file mode 100644 index 0000000..8ef9dfa --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_get-connection-route-aggregations.md @@ -0,0 +1,34 @@ +## equinix fabricv4 route-aggregations get-connection-route-aggregations + +Get All Aggregations + +### Synopsis + +This API provides capability to view all Route Aggregations attached to a Connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations get-connection-route-aggregations [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for get-connection-route-aggregations + --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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-by-uuid.md b/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-by-uuid.md new file mode 100644 index 0000000..f70c630 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 route-aggregations get-route-aggregation-by-uuid + +Get Aggregation + +### Synopsis + +This API provides capability to view a Route Aggregation by UUID + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations get-route-aggregation-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-route-aggregation-by-uuid + --request string JSON payload for request body fields + --route-aggregation-id string Route Aggregations Id (required) +``` + +### 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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-change-by-uuid.md b/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-change-by-uuid.md new file mode 100644 index 0000000..b65e8c0 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-change-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-aggregations get-route-aggregation-change-by-uuid + +Get Change By ID + +### Synopsis + +This API provides capability to retrieve a specific Route Aggregation's Changes + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations get-route-aggregation-change-by-uuid [flags] +``` + +### Options + +``` + --change-id string Routing Protocol Change UUID (required) + -h, --help help for get-route-aggregation-change-by-uuid + --request string JSON payload for request body fields + --route-aggregation-id string Route Aggregations Id (required) +``` + +### 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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-changes.md b/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-changes.md new file mode 100644 index 0000000..85d2efc --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-changes.md @@ -0,0 +1,36 @@ +## equinix fabricv4 route-aggregations get-route-aggregation-changes + +Get All Changes + +### Synopsis + +This API provides capability to retrieve all of a Route Aggregation's Changes + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations get-route-aggregation-changes [flags] +``` + +### Options + +``` + -h, --help help for get-route-aggregation-changes + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregation-id string Route Aggregations Id (required) +``` + +### 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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-connections.md b/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-connections.md new file mode 100644 index 0000000..09235b9 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_get-route-aggregation-connections.md @@ -0,0 +1,34 @@ +## equinix fabricv4 route-aggregations get-route-aggregation-connections + +Get All Connections on Route Aggregation + +### Synopsis + +This API provides capability to view all Connections using the Route Aggregation + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations get-route-aggregation-connections [flags] +``` + +### Options + +``` + -h, --help help for get-route-aggregation-connections + --request string JSON payload for request body fields + --route-aggregation-id string Route Aggregations Id (required) +``` + +### 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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_patch-route-aggregation-by-uuid.md b/docs/equinix_fabricv4_route-aggregations_patch-route-aggregation-by-uuid.md new file mode 100644 index 0000000..9c850f6 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_patch-route-aggregation-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-aggregations patch-route-aggregation-by-uuid + +Patch Aggregation + +### Synopsis + +This API provides capability to partially update a Route Aggregation + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations patch-route-aggregation-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for patch-route-aggregation-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregation-id string Route Aggregations Id (required) + --route-aggregations-patch-request-item string route-aggregations-patch-request-item field (JSON or string) +``` + +### 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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_search-route-aggregations.md b/docs/equinix_fabricv4_route-aggregations_search-route-aggregations.md new file mode 100644 index 0000000..41f48ea --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_search-route-aggregations.md @@ -0,0 +1,43 @@ +## equinix fabricv4 route-aggregations search-route-aggregations + +Search Aggregations + +### Synopsis + +This API provides capability to search Route Aggregations + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-aggregations search-route-aggregations [flags] +``` + +### Options + +``` + -h, --help help for search-route-aggregations + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregations-search-base-additional-properties string route-aggregations-search-base-additional-properties (JSON) + --route-aggregations-search-base-filter-additional-properties string route-aggregations-search-base-filter-additional-properties (JSON) + --route-aggregations-search-base-filter-and string route-aggregations-search-base-filter-and (JSON array) + --route-aggregations-search-base-pagination-additional-properties string route-aggregations-search-base-pagination-additional-properties (JSON) + --route-aggregations-search-base-pagination-limit int Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20. + --route-aggregations-search-base-pagination-next string URL relative to the next item in the response. + --route-aggregations-search-base-pagination-offset int Index of the first item returned in the response. The default is 0. + --route-aggregations-search-base-pagination-previous string URL relative to the previous item in the response. + --route-aggregations-search-base-pagination-total int Total number of elements returned. + --route-aggregations-search-base-sort string route-aggregations-search-base-sort (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 fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-filter-rules.md b/docs/equinix_fabricv4_route-filter-rules.md new file mode 100644 index 0000000..5a81113 --- /dev/null +++ b/docs/equinix_fabricv4_route-filter-rules.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-filter-rules + +Manage route-filter-rules resources + +### Synopsis + +Commands for managing route-filter-rules resources in the API + +### Options + +``` + -h, --help help for route-filter-rules +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 route-filter-rules create-route-filter-rule](equinix_fabricv4_route-filter-rules_create-route-filter-rule.md) - Create Route Filter Rule +* [equinix fabricv4 route-filter-rules create-route-filter-rules-in-bulk](equinix_fabricv4_route-filter-rules_create-route-filter-rules-in-bulk.md) - Bulk Create Route Filter Rules +* [equinix fabricv4 route-filter-rules delete-route-filter-rule-by-uuid](equinix_fabricv4_route-filter-rules_delete-route-filter-rule-by-uuid.md) - Delete Route Filter Rule +* [equinix fabricv4 route-filter-rules get-route-filter-rule-by-uuid](equinix_fabricv4_route-filter-rules_get-route-filter-rule-by-uuid.md) - Get Route Filter Rule By UUID +* [equinix fabricv4 route-filter-rules get-route-filter-rule-change-by-uuid](equinix_fabricv4_route-filter-rules_get-route-filter-rule-change-by-uuid.md) - Get Change By ID +* [equinix fabricv4 route-filter-rules get-route-filter-rule-changes](equinix_fabricv4_route-filter-rules_get-route-filter-rule-changes.md) - Get All Changes +* [equinix fabricv4 route-filter-rules get-route-filter-rules](equinix_fabricv4_route-filter-rules_get-route-filter-rules.md) - Get Route Filter Rules +* [equinix fabricv4 route-filter-rules patch-route-filter-rule-by-uuid](equinix_fabricv4_route-filter-rules_patch-route-filter-rule-by-uuid.md) - Patch Route Filter Rule +* [equinix fabricv4 route-filter-rules replace-route-filter-rule-by-uuid](equinix_fabricv4_route-filter-rules_replace-route-filter-rule-by-uuid.md) - Replace Route Filter Rule + diff --git a/docs/equinix_fabricv4_route-filter-rules_create-route-filter-rule.md b/docs/equinix_fabricv4_route-filter-rules_create-route-filter-rule.md new file mode 100644 index 0000000..905e182 --- /dev/null +++ b/docs/equinix_fabricv4_route-filter-rules_create-route-filter-rule.md @@ -0,0 +1,39 @@ +## equinix fabricv4 route-filter-rules create-route-filter-rule + +Create Route Filter Rule + +### Synopsis + +This API provides capability to create a Route Filter Rule + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filter-rules create-route-filter-rule [flags] +``` + +### Options + +``` + -h, --help help for create-route-filter-rule + --request string JSON payload for additional optional fields not exposed as flags + --route-filter-id string Route Filters Id (required) + --route-filter-rules-base-additional-properties string route-filter-rules-base-additional-properties (JSON) + --route-filter-rules-base-description string Customer-provided Route Filter Rule description + --route-filter-rules-base-name string route-filter-rules-base-name + --route-filter-rules-base-prefix string route-filter-rules-base-prefix + --route-filter-rules-base-prefix-match string route-filter-rules-base-prefix-match +``` + +### 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 fabricv4 route-filter-rules](equinix_fabricv4_route-filter-rules.md) - Manage route-filter-rules resources + diff --git a/docs/equinix_fabricv4_route-filter-rules_create-route-filter-rules-in-bulk.md b/docs/equinix_fabricv4_route-filter-rules_create-route-filter-rules-in-bulk.md new file mode 100644 index 0000000..317f5eb --- /dev/null +++ b/docs/equinix_fabricv4_route-filter-rules_create-route-filter-rules-in-bulk.md @@ -0,0 +1,36 @@ +## equinix fabricv4 route-filter-rules create-route-filter-rules-in-bulk + +Bulk Create Route Filter Rules + +### Synopsis + +This API provides capability to create bulk route filter rules + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filter-rules create-route-filter-rules-in-bulk [flags] +``` + +### Options + +``` + -h, --help help for create-route-filter-rules-in-bulk + --request string JSON payload for additional optional fields not exposed as flags + --route-filter-id string Route Filters Id (required) + --route-filter-rules-post-request-additional-properties string route-filter-rules-post-request-additional-properties (JSON) + --route-filter-rules-post-request-data string Route Filter Rule configuration (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 fabricv4 route-filter-rules](equinix_fabricv4_route-filter-rules.md) - Manage route-filter-rules resources + diff --git a/docs/equinix_fabricv4_route-filter-rules_delete-route-filter-rule-by-uuid.md b/docs/equinix_fabricv4_route-filter-rules_delete-route-filter-rule-by-uuid.md new file mode 100644 index 0000000..ae26e0c --- /dev/null +++ b/docs/equinix_fabricv4_route-filter-rules_delete-route-filter-rule-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-filter-rules delete-route-filter-rule-by-uuid + +Delete Route Filter Rule + +### Synopsis + +This API provides capability to delete a Route Filter Rule + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filter-rules delete-route-filter-rule-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-route-filter-rule-by-uuid + --request string JSON payload for request body fields + --route-filter-id string Route Filters Id (required) + --route-filter-rule-id string Route Filter Rules Id (required) +``` + +### 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 fabricv4 route-filter-rules](equinix_fabricv4_route-filter-rules.md) - Manage route-filter-rules resources + diff --git a/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-by-uuid.md b/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-by-uuid.md new file mode 100644 index 0000000..2982cd6 --- /dev/null +++ b/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-filter-rules get-route-filter-rule-by-uuid + +Get Route Filter Rule By UUID + +### Synopsis + +This API provides capability to view a Route Filter Rule by UUID + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filter-rules get-route-filter-rule-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-route-filter-rule-by-uuid + --request string JSON payload for request body fields + --route-filter-id string Route Filters Id (required) + --route-filter-rule-id string Route Filter Rules Id (required) +``` + +### 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 fabricv4 route-filter-rules](equinix_fabricv4_route-filter-rules.md) - Manage route-filter-rules resources + diff --git a/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-change-by-uuid.md b/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-change-by-uuid.md new file mode 100644 index 0000000..f281226 --- /dev/null +++ b/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-change-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 route-filter-rules get-route-filter-rule-change-by-uuid + +Get Change By ID + +### Synopsis + +This API provides capability to retrieve a specific Route Filter Rule's Changes + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filter-rules get-route-filter-rule-change-by-uuid [flags] +``` + +### Options + +``` + --change-id string Route Filter Rule Change UUID (required) + -h, --help help for get-route-filter-rule-change-by-uuid + --request string JSON payload for request body fields + --route-filter-id string Route Filters Id (required) + --route-filter-rule-id string Route Filter Rules Id (required) +``` + +### 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 fabricv4 route-filter-rules](equinix_fabricv4_route-filter-rules.md) - Manage route-filter-rules resources + diff --git a/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-changes.md b/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-changes.md new file mode 100644 index 0000000..c19e168 --- /dev/null +++ b/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rule-changes.md @@ -0,0 +1,37 @@ +## equinix fabricv4 route-filter-rules get-route-filter-rule-changes + +Get All Changes + +### Synopsis + +This API provides capability to retrieve all of a Route Filter Rule's Changes + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filter-rules get-route-filter-rule-changes [flags] +``` + +### Options + +``` + -h, --help help for get-route-filter-rule-changes + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --route-filter-id string Route Filters Id (required) + --route-filter-rule-id string Route Filter Rules Id (required) +``` + +### 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 fabricv4 route-filter-rules](equinix_fabricv4_route-filter-rules.md) - Manage route-filter-rules resources + diff --git a/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rules.md b/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rules.md new file mode 100644 index 0000000..dc201d4 --- /dev/null +++ b/docs/equinix_fabricv4_route-filter-rules_get-route-filter-rules.md @@ -0,0 +1,36 @@ +## equinix fabricv4 route-filter-rules get-route-filter-rules + +Get Route Filter Rules + +### Synopsis + +This API provides capability to get all Route Filters Rules for Fabric + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filter-rules get-route-filter-rules [flags] +``` + +### Options + +``` + -h, --help help for get-route-filter-rules + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --route-filter-id string Route Filters Id (required) +``` + +### 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 fabricv4 route-filter-rules](equinix_fabricv4_route-filter-rules.md) - Manage route-filter-rules resources + diff --git a/docs/equinix_fabricv4_route-filter-rules_patch-route-filter-rule-by-uuid.md b/docs/equinix_fabricv4_route-filter-rules_patch-route-filter-rule-by-uuid.md new file mode 100644 index 0000000..f649422 --- /dev/null +++ b/docs/equinix_fabricv4_route-filter-rules_patch-route-filter-rule-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 route-filter-rules patch-route-filter-rule-by-uuid + +Patch Route Filter Rule + +### Synopsis + +This API provides capability to partially update a Route Filter Rule + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filter-rules patch-route-filter-rule-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for patch-route-filter-rule-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --route-filter-id string Route Filters Id (required) + --route-filter-rule-id string Route Filter Rules Id (required) + --route-filter-rules-patch-request-item string route-filter-rules-patch-request-item field (JSON or string) +``` + +### 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 fabricv4 route-filter-rules](equinix_fabricv4_route-filter-rules.md) - Manage route-filter-rules resources + diff --git a/docs/equinix_fabricv4_route-filter-rules_replace-route-filter-rule-by-uuid.md b/docs/equinix_fabricv4_route-filter-rules_replace-route-filter-rule-by-uuid.md new file mode 100644 index 0000000..fc0d81f --- /dev/null +++ b/docs/equinix_fabricv4_route-filter-rules_replace-route-filter-rule-by-uuid.md @@ -0,0 +1,40 @@ +## equinix fabricv4 route-filter-rules replace-route-filter-rule-by-uuid + +Replace Route Filter Rule + +### Synopsis + +This API provides capability to replace a Route Filter Rule completely + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filter-rules replace-route-filter-rule-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for replace-route-filter-rule-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --route-filter-id string Route Filters Id (required) + --route-filter-rule-id string Route Filter Rules Id (required) + --route-filter-rules-base-additional-properties string route-filter-rules-base-additional-properties (JSON) + --route-filter-rules-base-description string Customer-provided Route Filter Rule description + --route-filter-rules-base-name string route-filter-rules-base-name + --route-filter-rules-base-prefix string route-filter-rules-base-prefix + --route-filter-rules-base-prefix-match string route-filter-rules-base-prefix-match +``` + +### 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 fabricv4 route-filter-rules](equinix_fabricv4_route-filter-rules.md) - Manage route-filter-rules resources + diff --git a/docs/equinix_fabricv4_route-filters.md b/docs/equinix_fabricv4_route-filters.md new file mode 100644 index 0000000..d7722f3 --- /dev/null +++ b/docs/equinix_fabricv4_route-filters.md @@ -0,0 +1,38 @@ +## equinix fabricv4 route-filters + +Manage route-filters resources + +### Synopsis + +Commands for managing route-filters resources in the API + +### Options + +``` + -h, --help help for route-filters +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 route-filters attach-connection-route-filter](equinix_fabricv4_route-filters_attach-connection-route-filter.md) - Attach Route Filter +* [equinix fabricv4 route-filters create-route-filter](equinix_fabricv4_route-filters_create-route-filter.md) - Create Route Filters +* [equinix fabricv4 route-filters delete-route-filter-by-uuid](equinix_fabricv4_route-filters_delete-route-filter-by-uuid.md) - Delete Route Filter +* [equinix fabricv4 route-filters detach-connection-route-filter](equinix_fabricv4_route-filters_detach-connection-route-filter.md) - Detach Route Filter +* [equinix fabricv4 route-filters get-connection-route-filter-by-uuid](equinix_fabricv4_route-filters_get-connection-route-filter-by-uuid.md) - Get Route Filter +* [equinix fabricv4 route-filters get-connection-route-filters](equinix_fabricv4_route-filters_get-connection-route-filters.md) - Get All Route Filters +* [equinix fabricv4 route-filters get-route-filter-by-uuid](equinix_fabricv4_route-filters_get-route-filter-by-uuid.md) - Get Route Filter By UUID +* [equinix fabricv4 route-filters get-route-filter-change-by-uuid](equinix_fabricv4_route-filters_get-route-filter-change-by-uuid.md) - Get Change By ID +* [equinix fabricv4 route-filters get-route-filter-changes](equinix_fabricv4_route-filters_get-route-filter-changes.md) - Get All Changes +* [equinix fabricv4 route-filters get-route-filter-connections](equinix_fabricv4_route-filters_get-route-filter-connections.md) - Get All Connections on Route Filter +* [equinix fabricv4 route-filters patch-route-filter-by-uuid](equinix_fabricv4_route-filters_patch-route-filter-by-uuid.md) - Patch Route Filter +* [equinix fabricv4 route-filters search-route-filters](equinix_fabricv4_route-filters_search-route-filters.md) - Search Route Filters + diff --git a/docs/equinix_fabricv4_route-filters_attach-connection-route-filter.md b/docs/equinix_fabricv4_route-filters_attach-connection-route-filter.md new file mode 100644 index 0000000..cd409b2 --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_attach-connection-route-filter.md @@ -0,0 +1,37 @@ +## equinix fabricv4 route-filters attach-connection-route-filter + +Attach Route Filter + +### Synopsis + +This API provides capability to attach a Route Filter to a Connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters attach-connection-route-filter [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + --connection-route-filters-base-additional-properties string connection-route-filters-base-additional-properties (JSON) + --connection-route-filters-base-direction string connection-route-filters-base-direction + -h, --help help for attach-connection-route-filter + --request string JSON payload for additional optional fields not exposed as flags + --route-filter-id string Route Filters Id (required) +``` + +### 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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_create-route-filter.md b/docs/equinix_fabricv4_route-filters_create-route-filter.md new file mode 100644 index 0000000..e40367d --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_create-route-filter.md @@ -0,0 +1,39 @@ +## equinix fabricv4 route-filters create-route-filter + +Create Route Filters + +### Synopsis + +This API provides capability to create a Route Filter + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters create-route-filter [flags] +``` + +### Options + +``` + -h, --help help for create-route-filter + --request string JSON payload for additional optional fields not exposed as flags + --route-filters-base-additional-properties string route-filters-base-additional-properties (JSON) + --route-filters-base-description string Customer-provided connection description + --route-filters-base-name string route-filters-base-name + --route-filters-base-project-additional-properties string route-filters-base-project-additional-properties (JSON) + --route-filters-base-project-project-id string Subscriber-assigned project ID + --route-filters-base-type string route-filters-base-type +``` + +### 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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_delete-route-filter-by-uuid.md b/docs/equinix_fabricv4_route-filters_delete-route-filter-by-uuid.md new file mode 100644 index 0000000..d1b71ed --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_delete-route-filter-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 route-filters delete-route-filter-by-uuid + +Delete Route Filter + +### Synopsis + +This API provides capability to delete a Route Filter + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters delete-route-filter-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-route-filter-by-uuid + --request string JSON payload for request body fields + --route-filter-id string Route Filters Id (required) +``` + +### 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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_detach-connection-route-filter.md b/docs/equinix_fabricv4_route-filters_detach-connection-route-filter.md new file mode 100644 index 0000000..d256de5 --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_detach-connection-route-filter.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-filters detach-connection-route-filter + +Detach Route Filter + +### Synopsis + +This API provides capability to detach a Route Filter from a Connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters detach-connection-route-filter [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for detach-connection-route-filter + --request string JSON payload for request body fields + --route-filter-id string Route Filters Id (required) +``` + +### 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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_get-connection-route-filter-by-uuid.md b/docs/equinix_fabricv4_route-filters_get-connection-route-filter-by-uuid.md new file mode 100644 index 0000000..88ec5ac --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_get-connection-route-filter-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-filters get-connection-route-filter-by-uuid + +Get Route Filter + +### Synopsis + +This API provides capability to view a specific Route Filter attached to a Connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters get-connection-route-filter-by-uuid [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for get-connection-route-filter-by-uuid + --request string JSON payload for request body fields + --route-filter-id string Route Filters Id (required) +``` + +### 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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_get-connection-route-filters.md b/docs/equinix_fabricv4_route-filters_get-connection-route-filters.md new file mode 100644 index 0000000..c69f281 --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_get-connection-route-filters.md @@ -0,0 +1,34 @@ +## equinix fabricv4 route-filters get-connection-route-filters + +Get All Route Filters + +### Synopsis + +This API provides capability to view all Route Filters attached to a Connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters get-connection-route-filters [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for get-connection-route-filters + --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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_get-route-filter-by-uuid.md b/docs/equinix_fabricv4_route-filters_get-route-filter-by-uuid.md new file mode 100644 index 0000000..77a510b --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_get-route-filter-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 route-filters get-route-filter-by-uuid + +Get Route Filter By UUID + +### Synopsis + +This API provides capability to view a Route Filter by UUID + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters get-route-filter-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-route-filter-by-uuid + --request string JSON payload for request body fields + --route-filter-id string Route Filters Id (required) +``` + +### 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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_get-route-filter-change-by-uuid.md b/docs/equinix_fabricv4_route-filters_get-route-filter-change-by-uuid.md new file mode 100644 index 0000000..dee6a04 --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_get-route-filter-change-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-filters get-route-filter-change-by-uuid + +Get Change By ID + +### Synopsis + +This API provides capability to retrieve a specific Route Filter's Changes + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters get-route-filter-change-by-uuid [flags] +``` + +### Options + +``` + --change-id string Routing Protocol Change UUID (required) + -h, --help help for get-route-filter-change-by-uuid + --request string JSON payload for request body fields + --route-filter-id string Route Filters Id (required) +``` + +### 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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_get-route-filter-changes.md b/docs/equinix_fabricv4_route-filters_get-route-filter-changes.md new file mode 100644 index 0000000..4556da4 --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_get-route-filter-changes.md @@ -0,0 +1,36 @@ +## equinix fabricv4 route-filters get-route-filter-changes + +Get All Changes + +### Synopsis + +This API provides capability to retrieve all of a Route Filter's Changes + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters get-route-filter-changes [flags] +``` + +### Options + +``` + -h, --help help for get-route-filter-changes + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --route-filter-id string Route Filters Id (required) +``` + +### 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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_get-route-filter-connections.md b/docs/equinix_fabricv4_route-filters_get-route-filter-connections.md new file mode 100644 index 0000000..033cd6f --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_get-route-filter-connections.md @@ -0,0 +1,34 @@ +## equinix fabricv4 route-filters get-route-filter-connections + +Get All Connections on Route Filter + +### Synopsis + +This API provides capability to view all Connections using the Route Filter + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters get-route-filter-connections [flags] +``` + +### Options + +``` + -h, --help help for get-route-filter-connections + --request string JSON payload for request body fields + --route-filter-id string Route Filters Id (required) +``` + +### 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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_patch-route-filter-by-uuid.md b/docs/equinix_fabricv4_route-filters_patch-route-filter-by-uuid.md new file mode 100644 index 0000000..37aa395 --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_patch-route-filter-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 route-filters patch-route-filter-by-uuid + +Patch Route Filter + +### Synopsis + +This API provides capability to partially update a Route Filter + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters patch-route-filter-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for patch-route-filter-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --route-filter-id string Route Filters Id (required) + --route-filters-patch-request-item string route-filters-patch-request-item field (JSON or string) +``` + +### 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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_search-route-filters.md b/docs/equinix_fabricv4_route-filters_search-route-filters.md new file mode 100644 index 0000000..cc5aca0 --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_search-route-filters.md @@ -0,0 +1,43 @@ +## equinix fabricv4 route-filters search-route-filters + +Search Route Filters + +### Synopsis + +This API provides capability to search Route Filters + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 route-filters search-route-filters [flags] +``` + +### Options + +``` + -h, --help help for search-route-filters + --request string JSON payload for additional optional fields not exposed as flags + --route-filters-search-base-additional-properties string route-filters-search-base-additional-properties (JSON) + --route-filters-search-base-filter-additional-properties string route-filters-search-base-filter-additional-properties (JSON) + --route-filters-search-base-filter-and string route-filters-search-base-filter-and (JSON array) + --route-filters-search-base-pagination-additional-properties string route-filters-search-base-pagination-additional-properties (JSON) + --route-filters-search-base-pagination-limit int Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20. + --route-filters-search-base-pagination-next string URL relative to the next item in the response. + --route-filters-search-base-pagination-offset int Index of the first item returned in the response. The default is 0. + --route-filters-search-base-pagination-previous string URL relative to the previous item in the response. + --route-filters-search-base-pagination-total int Total number of elements returned. + --route-filters-search-base-sort string route-filters-search-base-sort (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 fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_routing-protocols.md b/docs/equinix_fabricv4_routing-protocols.md new file mode 100644 index 0000000..b965f4f --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols.md @@ -0,0 +1,39 @@ +## equinix fabricv4 routing-protocols + +Manage routing-protocols resources + +### Synopsis + +Commands for managing routing-protocols resources in the API + +### Options + +``` + -h, --help help for routing-protocols +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 routing-protocols create-connection-routing-protocol](equinix_fabricv4_routing-protocols_create-connection-routing-protocol.md) - Create Protocol +* [equinix fabricv4 routing-protocols create-connection-routing-protocols-in-bulk](equinix_fabricv4_routing-protocols_create-connection-routing-protocols-in-bulk.md) - Bulk Create Protocol +* [equinix fabricv4 routing-protocols delete-connection-routing-protocol-by-uuid](equinix_fabricv4_routing-protocols_delete-connection-routing-protocol-by-uuid.md) - Delete Protocol +* [equinix fabricv4 routing-protocols get-connection-routing-protocol-all-bgp-actions](equinix_fabricv4_routing-protocols_get-connection-routing-protocol-all-bgp-actions.md) - Get BGP Actions +* [equinix fabricv4 routing-protocols get-connection-routing-protocol-by-uuid](equinix_fabricv4_routing-protocols_get-connection-routing-protocol-by-uuid.md) - Get Protocol +* [equinix fabricv4 routing-protocols get-connection-routing-protocols](equinix_fabricv4_routing-protocols_get-connection-routing-protocols.md) - GetRoutingProtocols +* [equinix fabricv4 routing-protocols get-connection-routing-protocols-bgp-action-by-uuid](equinix_fabricv4_routing-protocols_get-connection-routing-protocols-bgp-action-by-uuid.md) - Get BGP Action +* [equinix fabricv4 routing-protocols get-connection-routing-protocols-change-by-uuid](equinix_fabricv4_routing-protocols_get-connection-routing-protocols-change-by-uuid.md) - Get Change By ID +* [equinix fabricv4 routing-protocols get-connection-routing-protocols-changes](equinix_fabricv4_routing-protocols_get-connection-routing-protocols-changes.md) - Get Changes +* [equinix fabricv4 routing-protocols patch-connection-routing-protocol-by-uuid](equinix_fabricv4_routing-protocols_patch-connection-routing-protocol-by-uuid.md) - Patch Protocol +* [equinix fabricv4 routing-protocols post-connection-routing-protocol-bgp-action-by-uuid](equinix_fabricv4_routing-protocols_post-connection-routing-protocol-bgp-action-by-uuid.md) - Clear/Reset BGP +* [equinix fabricv4 routing-protocols replace-connection-routing-protocol-by-uuid](equinix_fabricv4_routing-protocols_replace-connection-routing-protocol-by-uuid.md) - Replace Protocol +* [equinix fabricv4 routing-protocols validate-routing-protocol](equinix_fabricv4_routing-protocols_validate-routing-protocol.md) - Validate Subnet + diff --git a/docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocol.md b/docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocol.md new file mode 100644 index 0000000..cf419c6 --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocol.md @@ -0,0 +1,48 @@ +## equinix fabricv4 routing-protocols create-connection-routing-protocol + +Create Protocol + +### Synopsis + +This API provides capability to create Routing Protocol for connections + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols create-connection-routing-protocol [flags] +``` + +### Options + +``` + --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-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) + --routing-protocol-base-routing-protocol-direct-type-name string routing-protocol-base-routing-protocol-direct-type-name + --routing-protocol-base-routing-protocol-direct-type-type string routing-protocol-base-routing-protocol-direct-type-type +``` + +### 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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + diff --git a/docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocols-in-bulk.md b/docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocols-in-bulk.md new file mode 100644 index 0000000..cdcdfe9 --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocols-in-bulk.md @@ -0,0 +1,36 @@ +## equinix fabricv4 routing-protocols create-connection-routing-protocols-in-bulk + +Bulk Create Protocol + +### Synopsis + +This API provides capability to create Routing Protocol for connections + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols create-connection-routing-protocols-in-bulk [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + --connection-routing-protocol-post-request-additional-properties string connection-routing-protocol-post-request-additional-properties (JSON) + --connection-routing-protocol-post-request-data string Connection routing protocol configuration (JSON array) + -h, --help help for create-connection-routing-protocols-in-bulk + --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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + diff --git a/docs/equinix_fabricv4_routing-protocols_delete-connection-routing-protocol-by-uuid.md b/docs/equinix_fabricv4_routing-protocols_delete-connection-routing-protocol-by-uuid.md new file mode 100644 index 0000000..939a354 --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_delete-connection-routing-protocol-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 routing-protocols delete-connection-routing-protocol-by-uuid + +Delete Protocol + +### Synopsis + +This API provides capability to delete Routing Protocols on virtual connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols delete-connection-routing-protocol-by-uuid [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for delete-connection-routing-protocol-by-uuid + --request string JSON payload for request body fields + --routing-protocol-id string Routing Protocol Id (required) +``` + +### 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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + diff --git a/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocol-all-bgp-actions.md b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocol-all-bgp-actions.md new file mode 100644 index 0000000..4d782b0 --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocol-all-bgp-actions.md @@ -0,0 +1,37 @@ +## equinix fabricv4 routing-protocols get-connection-routing-protocol-all-bgp-actions + +Get BGP Actions + +### Synopsis + +This API provides capability to get all BGP actions status + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols get-connection-routing-protocol-all-bgp-actions [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for get-connection-routing-protocol-all-bgp-actions + --limit int limit field + --offset int offset field + --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 + +``` + --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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + diff --git a/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocol-by-uuid.md b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocol-by-uuid.md new file mode 100644 index 0000000..1d46f45 --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocol-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 routing-protocols get-connection-routing-protocol-by-uuid + +Get Protocol + +### Synopsis + +This API provides capability to accept/reject user's virtual connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols get-connection-routing-protocol-by-uuid [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for get-connection-routing-protocol-by-uuid + --request string JSON payload for request body fields + --routing-protocol-id string Routing Protocol Id (required) +``` + +### 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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + diff --git a/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-bgp-action-by-uuid.md b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-bgp-action-by-uuid.md new file mode 100644 index 0000000..b8b3fdc --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-bgp-action-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 routing-protocols get-connection-routing-protocols-bgp-action-by-uuid + +Get BGP Action + +### Synopsis + +This API provides capability to retrieve specific BGP action + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols get-connection-routing-protocols-bgp-action-by-uuid [flags] +``` + +### Options + +``` + --action-id string BGP Action UUID (required) + --connection-id string Connection Id (required) + -h, --help help for get-connection-routing-protocols-bgp-action-by-uuid + --request string JSON payload for request body fields + --routing-protocol-id string Routing Protocol Id (required) +``` + +### 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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + diff --git a/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-change-by-uuid.md b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-change-by-uuid.md new file mode 100644 index 0000000..d5de1e5 --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-change-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 routing-protocols get-connection-routing-protocols-change-by-uuid + +Get Change By ID + +### Synopsis + +This API provides capability to retrieve specific Routing Protocol Change + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols get-connection-routing-protocols-change-by-uuid [flags] +``` + +### Options + +``` + --change-id string Routing Protocol Change UUID (required) + --connection-id string Connection Id (required) + -h, --help help for get-connection-routing-protocols-change-by-uuid + --request string JSON payload for request body fields + --routing-protocol-id string Routing Protocol Id (required) +``` + +### 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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + diff --git a/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-changes.md b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-changes.md new file mode 100644 index 0000000..c70eb55 --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols-changes.md @@ -0,0 +1,37 @@ +## equinix fabricv4 routing-protocols get-connection-routing-protocols-changes + +Get Changes + +### Synopsis + +This API provides capability to retrieve user's Routing Protocol Changes + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols get-connection-routing-protocols-changes [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for get-connection-routing-protocols-changes + --limit int limit field + --offset int offset field + --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 + +``` + --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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + diff --git a/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols.md b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols.md new file mode 100644 index 0000000..7beebed --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_get-connection-routing-protocols.md @@ -0,0 +1,36 @@ +## equinix fabricv4 routing-protocols get-connection-routing-protocols + +GetRoutingProtocols + +### Synopsis + +This API provides capability to get Routing Protocols for connections + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols get-connection-routing-protocols [flags] +``` + +### Options + +``` + --connection-id string Connection Id (required) + -h, --help help for get-connection-routing-protocols + --limit int limit field + --offset int offset 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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + diff --git a/docs/equinix_fabricv4_routing-protocols_patch-connection-routing-protocol-by-uuid.md b/docs/equinix_fabricv4_routing-protocols_patch-connection-routing-protocol-by-uuid.md new file mode 100644 index 0000000..40fe3ec --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_patch-connection-routing-protocol-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 routing-protocols patch-connection-routing-protocol-by-uuid + +Patch Protocol + +### Synopsis + +This API provides capability to partially update Routing Protocols on a virtual connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols patch-connection-routing-protocol-by-uuid [flags] +``` + +### Options + +``` + --connection-change-operation string connection-change-operation field (JSON or string) + --connection-id string Connection Id (required) + -h, --help help for patch-connection-routing-protocol-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 + +``` + --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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + 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 new file mode 100644 index 0000000..c939ea8 --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_post-connection-routing-protocol-bgp-action-by-uuid.md @@ -0,0 +1,37 @@ +## equinix fabricv4 routing-protocols post-connection-routing-protocol-bgp-action-by-uuid + +Clear/Reset BGP + +### Synopsis + +This API provides capability to clear/reset Routing Protocols BGP session + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols post-connection-routing-protocol-bgp-action-by-uuid [flags] +``` + +### 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) +``` + +### 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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + 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 new file mode 100644 index 0000000..fceda81 --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_replace-connection-routing-protocol-by-uuid.md @@ -0,0 +1,49 @@ +## equinix fabricv4 routing-protocols replace-connection-routing-protocol-by-uuid + +Replace Protocol + +### Synopsis + +This API provides capability to replace complete Routing Protocols on a virtual connection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols replace-connection-routing-protocol-by-uuid [flags] +``` + +### Options + +``` + --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-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) + --routing-protocol-base-routing-protocol-direct-type-name string routing-protocol-base-routing-protocol-direct-type-name + --routing-protocol-base-routing-protocol-direct-type-type string routing-protocol-base-routing-protocol-direct-type-type + --routing-protocol-id string Routing Protocol Id (required) +``` + +### 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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + diff --git a/docs/equinix_fabricv4_routing-protocols_validate-routing-protocol.md b/docs/equinix_fabricv4_routing-protocols_validate-routing-protocol.md new file mode 100644 index 0000000..a460579 --- /dev/null +++ b/docs/equinix_fabricv4_routing-protocols_validate-routing-protocol.md @@ -0,0 +1,37 @@ +## equinix fabricv4 routing-protocols validate-routing-protocol + +Validate Subnet + +### Synopsis + +This API provides capability to validate all subnets associated with any connection in the given FCR + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 routing-protocols validate-routing-protocol [flags] +``` + +### Options + +``` + -h, --help help for validate-routing-protocol + --request string JSON payload for additional optional fields not exposed as flags + --router-id string Cloud Router UUID (required) + --validate-request-additional-properties string validate-request-additional-properties (JSON) + --validate-request-filter-additional-properties string validate-request-filter-additional-properties (JSON) + --validate-request-filter-and string validate-request-filter-and (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 fabricv4 routing-protocols](equinix_fabricv4_routing-protocols.md) - Manage routing-protocols resources + diff --git a/docs/equinix_fabricv4_service-profiles.md b/docs/equinix_fabricv4_service-profiles.md new file mode 100644 index 0000000..f813308 --- /dev/null +++ b/docs/equinix_fabricv4_service-profiles.md @@ -0,0 +1,34 @@ +## equinix fabricv4 service-profiles + +Manage service-profiles resources + +### Synopsis + +Commands for managing service-profiles resources in the API + +### Options + +``` + -h, --help help for service-profiles +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 service-profiles create-service-profile](equinix_fabricv4_service-profiles_create-service-profile.md) - Create Profile +* [equinix fabricv4 service-profiles delete-service-profile-by-uuid](equinix_fabricv4_service-profiles_delete-service-profile-by-uuid.md) - Delete Profile +* [equinix fabricv4 service-profiles get-service-profile-by-uuid](equinix_fabricv4_service-profiles_get-service-profile-by-uuid.md) - Get Profile +* [equinix fabricv4 service-profiles get-service-profile-metros-by-uuid](equinix_fabricv4_service-profiles_get-service-profile-metros-by-uuid.md) - Get Profile Metros +* [equinix fabricv4 service-profiles get-service-profiles](equinix_fabricv4_service-profiles_get-service-profiles.md) - Get all Profiles +* [equinix fabricv4 service-profiles put-service-profile-by-uuid](equinix_fabricv4_service-profiles_put-service-profile-by-uuid.md) - Replace Profile +* [equinix fabricv4 service-profiles search-service-profiles](equinix_fabricv4_service-profiles_search-service-profiles.md) - Profile Search +* [equinix fabricv4 service-profiles update-service-profile-by-uuid](equinix_fabricv4_service-profiles_update-service-profile-by-uuid.md) - Update Profile + diff --git a/docs/equinix_fabricv4_service-profiles_create-service-profile.md b/docs/equinix_fabricv4_service-profiles_create-service-profile.md new file mode 100644 index 0000000..eec8e68 --- /dev/null +++ b/docs/equinix_fabricv4_service-profiles_create-service-profile.md @@ -0,0 +1,56 @@ +## equinix fabricv4 service-profiles create-service-profile + +Create Profile + +### Synopsis + +Create Service Profile creates Equinix Fabric™ Service Profile. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-profiles create-service-profile [flags] +``` + +### Options + +``` + -h, --help help for create-service-profile + --request string JSON payload for additional optional fields not exposed as flags + --service-profile-request-access-point-type-configs string service-profile-request-access-point-type-configs (JSON array) + --service-profile-request-additional-properties string service-profile-request-additional-properties (JSON) + --service-profile-request-allowed-emails string service-profile-request-allowed-emails (JSON array) + --service-profile-request-custom-fields string service-profile-request-custom-fields (JSON array) + --service-profile-request-description string User-provided service description should be of maximum length 375 + --service-profile-request-href string Service Profile URI response attribute + --service-profile-request-marketing-info-additional-properties string service-profile-request-marketing-info-additional-properties (JSON) + --service-profile-request-marketing-info-logo string Logo file name + --service-profile-request-marketing-info-process-steps string service-profile-request-marketing-info-process-steps (JSON array) + --service-profile-request-marketing-info-promotion Profile promotion on marketplace + --service-profile-request-metros string Derived response attribute. (JSON array) + --service-profile-request-name string Customer-assigned service profile name + --service-profile-request-notifications string Recipients of notifications on service profile change (JSON array) + --service-profile-request-ports string service-profile-request-ports (JSON array) + --service-profile-request-project-additional-properties string service-profile-request-project-additional-properties (JSON) + --service-profile-request-project-id string service-profile-request-project-id + --service-profile-request-project-project-id string Subscriber-assigned project ID + --service-profile-request-self-profile response attribute indicates whether the profile belongs to the same organization as the api-invoker. + --service-profile-request-tags string service-profile-request-tags (JSON array) + --service-profile-request-type string service-profile-request-type + --service-profile-request-uuid string Equinix-assigned service profile identifier + --service-profile-request-virtual-devices string service-profile-request-virtual-devices (JSON array) + --service-profile-request-visibility string service-profile-request-visibility +``` + +### 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 fabricv4 service-profiles](equinix_fabricv4_service-profiles.md) - Manage service-profiles resources + diff --git a/docs/equinix_fabricv4_service-profiles_delete-service-profile-by-uuid.md b/docs/equinix_fabricv4_service-profiles_delete-service-profile-by-uuid.md new file mode 100644 index 0000000..99141f6 --- /dev/null +++ b/docs/equinix_fabricv4_service-profiles_delete-service-profile-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 service-profiles delete-service-profile-by-uuid + +Delete Profile + +### Synopsis + +delete Service Profile by UUID + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-profiles delete-service-profile-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-service-profile-by-uuid + --request string JSON payload for request body fields + --service-profile-id string Service Profile UUID (required) +``` + +### 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 fabricv4 service-profiles](equinix_fabricv4_service-profiles.md) - Manage service-profiles resources + diff --git a/docs/equinix_fabricv4_service-profiles_get-service-profile-by-uuid.md b/docs/equinix_fabricv4_service-profiles_get-service-profile-by-uuid.md new file mode 100644 index 0000000..ef8dc78 --- /dev/null +++ b/docs/equinix_fabricv4_service-profiles_get-service-profile-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 service-profiles get-service-profile-by-uuid + +Get Profile + +### Synopsis + +Get service profile by UUID. View Point parameter if set to zSide will give seller's view of the profile otherwise buyer's view. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-profiles get-service-profile-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-service-profile-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --service-profile-id string Service Profile UUID (required) + --view-point string view-point 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 fabricv4 service-profiles](equinix_fabricv4_service-profiles.md) - Manage service-profiles resources + diff --git a/docs/equinix_fabricv4_service-profiles_get-service-profile-metros-by-uuid.md b/docs/equinix_fabricv4_service-profiles_get-service-profile-metros-by-uuid.md new file mode 100644 index 0000000..d8847dc --- /dev/null +++ b/docs/equinix_fabricv4_service-profiles_get-service-profile-metros-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 service-profiles get-service-profile-metros-by-uuid + +Get Profile Metros + +### Synopsis + +Get service profile metros by UUID. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-profiles get-service-profile-metros-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-service-profile-metros-by-uuid + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --service-profile-id string Service Profile UUID (required) +``` + +### 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 fabricv4 service-profiles](equinix_fabricv4_service-profiles.md) - Manage service-profiles resources + diff --git a/docs/equinix_fabricv4_service-profiles_get-service-profiles.md b/docs/equinix_fabricv4_service-profiles_get-service-profiles.md new file mode 100644 index 0000000..80b9c92 --- /dev/null +++ b/docs/equinix_fabricv4_service-profiles_get-service-profiles.md @@ -0,0 +1,36 @@ +## equinix fabricv4 service-profiles get-service-profiles + +Get all Profiles + +### Synopsis + +The API request returns all Equinix Fabric Service Profiles in accordance with the view point requested. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-profiles get-service-profiles [flags] +``` + +### Options + +``` + -h, --help help for get-service-profiles + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --view-point string view-point 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 fabricv4 service-profiles](equinix_fabricv4_service-profiles.md) - Manage service-profiles resources + diff --git a/docs/equinix_fabricv4_service-profiles_put-service-profile-by-uuid.md b/docs/equinix_fabricv4_service-profiles_put-service-profile-by-uuid.md new file mode 100644 index 0000000..97419f3 --- /dev/null +++ b/docs/equinix_fabricv4_service-profiles_put-service-profile-by-uuid.md @@ -0,0 +1,58 @@ +## equinix fabricv4 service-profiles put-service-profile-by-uuid + +Replace Profile + +### Synopsis + +This API request replaces a service profile definition + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-profiles put-service-profile-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for put-service-profile-by-uuid + --if-match string if-match field + --request string JSON payload for additional optional fields not exposed as flags + --service-profile-id string Service Profile UUID (required) + --service-profile-request-access-point-type-configs string service-profile-request-access-point-type-configs (JSON array) + --service-profile-request-additional-properties string service-profile-request-additional-properties (JSON) + --service-profile-request-allowed-emails string service-profile-request-allowed-emails (JSON array) + --service-profile-request-custom-fields string service-profile-request-custom-fields (JSON array) + --service-profile-request-description string User-provided service description should be of maximum length 375 + --service-profile-request-href string Service Profile URI response attribute + --service-profile-request-marketing-info-additional-properties string service-profile-request-marketing-info-additional-properties (JSON) + --service-profile-request-marketing-info-logo string Logo file name + --service-profile-request-marketing-info-process-steps string service-profile-request-marketing-info-process-steps (JSON array) + --service-profile-request-marketing-info-promotion Profile promotion on marketplace + --service-profile-request-metros string Derived response attribute. (JSON array) + --service-profile-request-name string Customer-assigned service profile name + --service-profile-request-notifications string Recipients of notifications on service profile change (JSON array) + --service-profile-request-ports string service-profile-request-ports (JSON array) + --service-profile-request-project-additional-properties string service-profile-request-project-additional-properties (JSON) + --service-profile-request-project-id string service-profile-request-project-id + --service-profile-request-project-project-id string Subscriber-assigned project ID + --service-profile-request-self-profile response attribute indicates whether the profile belongs to the same organization as the api-invoker. + --service-profile-request-tags string service-profile-request-tags (JSON array) + --service-profile-request-type string service-profile-request-type + --service-profile-request-uuid string Equinix-assigned service profile identifier + --service-profile-request-virtual-devices string service-profile-request-virtual-devices (JSON array) + --service-profile-request-visibility string service-profile-request-visibility +``` + +### 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 fabricv4 service-profiles](equinix_fabricv4_service-profiles.md) - Manage service-profiles resources + diff --git a/docs/equinix_fabricv4_service-profiles_search-service-profiles.md b/docs/equinix_fabricv4_service-profiles_search-service-profiles.md new file mode 100644 index 0000000..fe9609c --- /dev/null +++ b/docs/equinix_fabricv4_service-profiles_search-service-profiles.md @@ -0,0 +1,41 @@ +## equinix fabricv4 service-profiles search-service-profiles + +Profile Search + +### Synopsis + +Search service profiles by search criteria + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-profiles search-service-profiles [flags] +``` + +### Options + +``` + -h, --help help for search-service-profiles + --request string JSON payload for additional optional fields not exposed as flags + --service-profile-search-request-additional-properties string service-profile-search-request-additional-properties (JSON) + --service-profile-search-request-filter-service-profile-and-filter string service-profile-search-request-filter-service-profile-and-filter (JSON) + --service-profile-search-request-filter-service-profile-simple-expression string service-profile-search-request-filter-service-profile-simple-expression (JSON) + --service-profile-search-request-pagination-additional-properties string service-profile-search-request-pagination-additional-properties (JSON) + --service-profile-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --service-profile-search-request-pagination-offset int Index of the first element. + --service-profile-search-request-sort string service-profile-search-request-sort (JSON array) + --view-point string view-point 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 fabricv4 service-profiles](equinix_fabricv4_service-profiles.md) - Manage service-profiles resources + diff --git a/docs/equinix_fabricv4_service-profiles_update-service-profile-by-uuid.md b/docs/equinix_fabricv4_service-profiles_update-service-profile-by-uuid.md new file mode 100644 index 0000000..9cca04a --- /dev/null +++ b/docs/equinix_fabricv4_service-profiles_update-service-profile-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 service-profiles update-service-profile-by-uuid + +Update Profile + +### Synopsis + +Update Service Profile by UUID + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-profiles update-service-profile-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for update-service-profile-by-uuid + --if-match string if-match field + --json-patch-operation string json-patch-operation field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --service-profile-id string Service Profile UUID (required) +``` + +### 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 fabricv4 service-profiles](equinix_fabricv4_service-profiles.md) - Manage service-profiles resources + diff --git a/docs/equinix_fabricv4_service-tokens.md b/docs/equinix_fabricv4_service-tokens.md new file mode 100644 index 0000000..3016a29 --- /dev/null +++ b/docs/equinix_fabricv4_service-tokens.md @@ -0,0 +1,33 @@ +## equinix fabricv4 service-tokens + +Manage service-tokens resources + +### Synopsis + +Commands for managing service-tokens resources in the API + +### Options + +``` + -h, --help help for service-tokens +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 service-tokens create-service-token](equinix_fabricv4_service-tokens_create-service-token.md) - Create Service Token +* [equinix fabricv4 service-tokens create-service-token-action](equinix_fabricv4_service-tokens_create-service-token-action.md) - ServiceToken Actions +* [equinix fabricv4 service-tokens delete-service-token-by-uuid](equinix_fabricv4_service-tokens_delete-service-token-by-uuid.md) - Delete Token by uuid +* [equinix fabricv4 service-tokens get-service-token-by-uuid](equinix_fabricv4_service-tokens_get-service-token-by-uuid.md) - Get Token by uuid +* [equinix fabricv4 service-tokens get-service-tokens](equinix_fabricv4_service-tokens_get-service-tokens.md) - Get All Tokens +* [equinix fabricv4 service-tokens search-service-tokens](equinix_fabricv4_service-tokens_search-service-tokens.md) - Search servicetokens +* [equinix fabricv4 service-tokens update-service-token-by-uuid](equinix_fabricv4_service-tokens_update-service-token-by-uuid.md) - Update Token By ID + diff --git a/docs/equinix_fabricv4_service-tokens_create-service-token-action.md b/docs/equinix_fabricv4_service-tokens_create-service-token-action.md new file mode 100644 index 0000000..0416ad4 --- /dev/null +++ b/docs/equinix_fabricv4_service-tokens_create-service-token-action.md @@ -0,0 +1,36 @@ +## equinix fabricv4 service-tokens create-service-token-action + +ServiceToken Actions + +### Synopsis + +This API provides capability to accept/reject user's servicetokens + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-tokens create-service-token-action [flags] +``` + +### Options + +``` + -h, --help help for create-service-token-action + --request string JSON payload for additional optional fields not exposed as flags + --service-token-action-request-additional-properties string service-token-action-request-additional-properties (JSON) + --service-token-action-request-type string service-token-action-request-type + --service-token-id string Service Token UUID (required) +``` + +### 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 fabricv4 service-tokens](equinix_fabricv4_service-tokens.md) - Manage service-tokens resources + diff --git a/docs/equinix_fabricv4_service-tokens_create-service-token.md b/docs/equinix_fabricv4_service-tokens_create-service-token.md new file mode 100644 index 0000000..911309b --- /dev/null +++ b/docs/equinix_fabricv4_service-tokens_create-service-token.md @@ -0,0 +1,83 @@ +## equinix fabricv4 service-tokens create-service-token + +Create Service Token + +### Synopsis + +Create Service Tokens generates Equinix Fabric™ service tokens. These tokens authorize users to access protected resources and services. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-tokens create-service-token [flags] +``` + +### Options + +``` + --dry-run dry-run field + -h, --help help for create-service-token + --request string JSON payload for additional optional fields not exposed as flags + --service-token-account-account-name string Account name + --service-token-account-account-number int Account number + --service-token-account-additional-properties string service-token-account-additional-properties (JSON) + --service-token-account-global-cust-id string Account name + --service-token-account-global-org-id string Global organization identifier + --service-token-account-global-organization-name string Global organization name + --service-token-account-org-id int Customer organization identifier + --service-token-account-organization-name string Customer organization name + --service-token-account-reseller-account-name string Reseller account name + --service-token-account-reseller-account-number int Reseller account number + --service-token-account-reseller-org-id int Reseller customer organization identifier + --service-token-account-reseller-ucm-id string Reseller account ucmId + --service-token-account-ucm-id string Account ucmId + --service-token-additional-properties string service-token-additional-properties (JSON) + --service-token-changelog-additional-properties string service-token-changelog-additional-properties (JSON) + --service-token-changelog-created-by string Created by User Key + --service-token-changelog-created-by-email string Created by User Email Address + --service-token-changelog-created-by-full-name string Created by User Full Name + --service-token-changelog-created-date-time string service-token-changelog-created-date-time (JSON) + --service-token-changelog-deleted-by string Deleted by User Key + --service-token-changelog-deleted-by-email string Deleted by User Email Address + --service-token-changelog-deleted-by-full-name string Deleted by User Full Name + --service-token-changelog-deleted-date-time string service-token-changelog-deleted-date-time (JSON) + --service-token-changelog-updated-by string Updated by User Key + --service-token-changelog-updated-by-email string Updated by User Email Address + --service-token-changelog-updated-by-full-name string Updated by User Full Name + --service-token-changelog-updated-date-time string service-token-changelog-updated-date-time (JSON) + --service-token-connection-a-side string service-token-connection-a-side (JSON) + --service-token-connection-additional-properties string service-token-connection-additional-properties (JSON) + --service-token-connection-allow-custom-bandwidth Allow custom bandwidth value + --service-token-connection-allow-remote-connection Authorization to connect remotely + --service-token-connection-bandwidth-limit int Connection bandwidth limit in Mbps + --service-token-connection-href string An absolute URL that is the subject of the link's context. + --service-token-connection-supported-bandwidths string List of permitted bandwidths. (JSON array) + --service-token-connection-type string service-token-connection-type + --service-token-connection-uuid string Equinix-assigned connection identifier + --service-token-connection-z-side string service-token-connection-z-side (JSON) + --service-token-description string Customer-provided service token description + --service-token-expiry int Deprecated + --service-token-href string An absolute URL that is the subject of the link's context. + --service-token-issuer-side string information about token side + Deprecated + --service-token-name string Customer-provided service token name + --service-token-notifications string Service token related notifications (JSON array) + --service-token-project-additional-properties string service-token-project-additional-properties (JSON) + --service-token-project-project-id string Subscriber-assigned project ID + --service-token-state string service-token-state + --service-token-type string service-token-type + --service-token-uuid string Equinix-assigned service token identifier +``` + +### 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 fabricv4 service-tokens](equinix_fabricv4_service-tokens.md) - Manage service-tokens resources + diff --git a/docs/equinix_fabricv4_service-tokens_delete-service-token-by-uuid.md b/docs/equinix_fabricv4_service-tokens_delete-service-token-by-uuid.md new file mode 100644 index 0000000..fd4b6f2 --- /dev/null +++ b/docs/equinix_fabricv4_service-tokens_delete-service-token-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 service-tokens delete-service-token-by-uuid + +Delete Token by uuid + +### Synopsis + +Delete Service Tokens removes an Equinix Fabric service token corresponding to the specified uuid which are in INACTIVE state. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-tokens delete-service-token-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-service-token-by-uuid + --request string JSON payload for request body fields + --service-token-id string Service Token UUID (required) +``` + +### 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 fabricv4 service-tokens](equinix_fabricv4_service-tokens.md) - Manage service-tokens resources + diff --git a/docs/equinix_fabricv4_service-tokens_get-service-token-by-uuid.md b/docs/equinix_fabricv4_service-tokens_get-service-token-by-uuid.md new file mode 100644 index 0000000..d56f461 --- /dev/null +++ b/docs/equinix_fabricv4_service-tokens_get-service-token-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 service-tokens get-service-token-by-uuid + +Get Token by uuid + +### Synopsis + +Get Specified Service Tokens uses the uuid of an Equinix Fabric service token to return details about the token's type, state, location, bandwidth, and other key properties. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-tokens get-service-token-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-service-token-by-uuid + --request string JSON payload for request body fields + --service-token-id string Service Token UUID (required) +``` + +### 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 fabricv4 service-tokens](equinix_fabricv4_service-tokens.md) - Manage service-tokens resources + diff --git a/docs/equinix_fabricv4_service-tokens_get-service-tokens.md b/docs/equinix_fabricv4_service-tokens_get-service-tokens.md new file mode 100644 index 0000000..dc30651 --- /dev/null +++ b/docs/equinix_fabricv4_service-tokens_get-service-tokens.md @@ -0,0 +1,35 @@ +## equinix fabricv4 service-tokens get-service-tokens + +Get All Tokens + +### Synopsis + +Get All ServiceTokens creates a list of all Equinix Fabric service tokens associated with the subscriber's account. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-tokens get-service-tokens [flags] +``` + +### Options + +``` + -h, --help help for get-service-tokens + --limit float limit field + --offset float offset 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 fabricv4 service-tokens](equinix_fabricv4_service-tokens.md) - Manage service-tokens resources + diff --git a/docs/equinix_fabricv4_service-tokens_search-service-tokens.md b/docs/equinix_fabricv4_service-tokens_search-service-tokens.md new file mode 100644 index 0000000..26d28b9 --- /dev/null +++ b/docs/equinix_fabricv4_service-tokens_search-service-tokens.md @@ -0,0 +1,44 @@ +## equinix fabricv4 service-tokens search-service-tokens + +Search servicetokens + +### Synopsis + +The API provides capability to get list of user's servicetokens using search criteria, including optional filtering, pagination and sorting + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-tokens search-service-tokens [flags] +``` + +### Options + +``` + -h, --help help for search-service-tokens + --limit float limit field + --offset float offset field + --request string JSON payload for additional optional fields not exposed as flags + --service-token-search-request-additional-properties string service-token-search-request-additional-properties (JSON) + --service-token-search-request-filter-additional-properties string service-token-search-request-filter-additional-properties (JSON) + --service-token-search-request-filter-and string service-token-search-request-filter-and (JSON array) + --service-token-search-request-filter-operator string service-token-search-request-filter-operator + --service-token-search-request-filter-property string service-token-search-request-filter-property + --service-token-search-request-filter-values string service-token-search-request-filter-values (JSON array) + --service-token-search-request-pagination-additional-properties string service-token-search-request-pagination-additional-properties (JSON) + --service-token-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --service-token-search-request-pagination-offset int Index of the first element. +``` + +### 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 fabricv4 service-tokens](equinix_fabricv4_service-tokens.md) - Manage service-tokens resources + diff --git a/docs/equinix_fabricv4_service-tokens_update-service-token-by-uuid.md b/docs/equinix_fabricv4_service-tokens_update-service-token-by-uuid.md new file mode 100644 index 0000000..1ea3168 --- /dev/null +++ b/docs/equinix_fabricv4_service-tokens_update-service-token-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 service-tokens update-service-token-by-uuid + +Update Token By ID + +### Synopsis + +This API provides capability to update user's Service Token + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 service-tokens update-service-token-by-uuid [flags] +``` + +### Options + +``` + --dry-run dry-run field + -h, --help help for update-service-token-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --service-token-change-operation string service-token-change-operation field (JSON or string) + --service-token-id string Service Token UUID (required) +``` + +### 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 fabricv4 service-tokens](equinix_fabricv4_service-tokens.md) - Manage service-tokens resources + diff --git a/docs/equinix_fabricv4_statistics.md b/docs/equinix_fabricv4_statistics.md new file mode 100644 index 0000000..7efc00b --- /dev/null +++ b/docs/equinix_fabricv4_statistics.md @@ -0,0 +1,28 @@ +## equinix fabricv4 statistics + +Manage statistics resources + +### Synopsis + +Commands for managing statistics resources in the API + +### Options + +``` + -h, --help help for statistics +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 statistics get-connection-stats-by-port-uuid](equinix_fabricv4_statistics_get-connection-stats-by-port-uuid.md) - Get Stats by uuid **(DEPRECATED)** +* [equinix fabricv4 statistics get-port-stats-by-port-uuid](equinix_fabricv4_statistics_get-port-stats-by-port-uuid.md) - Get Stats by uuid **(DEPRECATED)** + diff --git a/docs/equinix_fabricv4_statistics_get-connection-stats-by-port-uuid.md b/docs/equinix_fabricv4_statistics_get-connection-stats-by-port-uuid.md new file mode 100644 index 0000000..c55c4e6 --- /dev/null +++ b/docs/equinix_fabricv4_statistics_get-connection-stats-by-port-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 statistics get-connection-stats-by-port-uuid + +Get Stats by uuid **(DEPRECATED)** + +### Synopsis + +This API provides service-level metrics so that you can view access and gather key information required to manage service subscription sizing and capacity **(DEPRECATED)** Deprecated + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 statistics get-connection-stats-by-port-uuid [flags] +``` + +### Options + +``` + --connection-id string Connection UUID (required) + -h, --help help for get-connection-stats-by-port-uuid + --request string JSON payload for additional optional fields not exposed as flags + --view-point string view-point 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 fabricv4 statistics](equinix_fabricv4_statistics.md) - Manage statistics resources + diff --git a/docs/equinix_fabricv4_statistics_get-port-stats-by-port-uuid.md b/docs/equinix_fabricv4_statistics_get-port-stats-by-port-uuid.md new file mode 100644 index 0000000..8787313 --- /dev/null +++ b/docs/equinix_fabricv4_statistics_get-port-stats-by-port-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 statistics get-port-stats-by-port-uuid + +Get Stats by uuid **(DEPRECATED)** + +### Synopsis + +This API provides service-level traffic metrics so that you can view access and gather key information required to manage service subscription sizing and capacity.**(DEPRECATED)** Deprecated + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 statistics get-port-stats-by-port-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-port-stats-by-port-uuid + --port-id string Port 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 fabricv4 statistics](equinix_fabricv4_statistics.md) - Manage statistics resources + diff --git a/docs/equinix_fabricv4_stream-alert-rules.md b/docs/equinix_fabricv4_stream-alert-rules.md new file mode 100644 index 0000000..f4f3e65 --- /dev/null +++ b/docs/equinix_fabricv4_stream-alert-rules.md @@ -0,0 +1,31 @@ +## equinix fabricv4 stream-alert-rules + +Manage stream-alert-rules resources + +### Synopsis + +Commands for managing stream-alert-rules resources in the API + +### Options + +``` + -h, --help help for stream-alert-rules +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 stream-alert-rules create-stream-alert-rules](equinix_fabricv4_stream-alert-rules_create-stream-alert-rules.md) - Create Stream Alert Rules +* [equinix fabricv4 stream-alert-rules delete-stream-alert-rule-by-uuid](equinix_fabricv4_stream-alert-rules_delete-stream-alert-rule-by-uuid.md) - Update Stream Alert Rules +* [equinix fabricv4 stream-alert-rules get-stream-alert-rule-by-uuid](equinix_fabricv4_stream-alert-rules_get-stream-alert-rule-by-uuid.md) - Get Stream Alert Rules +* [equinix fabricv4 stream-alert-rules get-stream-alert-rules](equinix_fabricv4_stream-alert-rules_get-stream-alert-rules.md) - Get Stream Alert Rules +* [equinix fabricv4 stream-alert-rules update-stream-alert-rule-by-uuid](equinix_fabricv4_stream-alert-rules_update-stream-alert-rule-by-uuid.md) - Update Stream Alert Rules + diff --git a/docs/equinix_fabricv4_stream-alert-rules_create-stream-alert-rules.md b/docs/equinix_fabricv4_stream-alert-rules_create-stream-alert-rules.md new file mode 100644 index 0000000..8d1608f --- /dev/null +++ b/docs/equinix_fabricv4_stream-alert-rules_create-stream-alert-rules.md @@ -0,0 +1,49 @@ +## equinix fabricv4 stream-alert-rules create-stream-alert-rules + +Create Stream Alert Rules + +### Synopsis + +This API provides capability to create user's Stream Alert Rules + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 stream-alert-rules create-stream-alert-rules [flags] +``` + +### Options + +``` + --alert-rule-post-request-additional-properties string alert-rule-post-request-additional-properties (JSON) + --alert-rule-post-request-description string Customer-provided stream description + --alert-rule-post-request-detection-method-additional-properties string alert-rule-post-request-detection-method-additional-properties (JSON) + --alert-rule-post-request-detection-method-critical-threshold string Stream alert rule metric critical threshold + --alert-rule-post-request-detection-method-operand string alert-rule-post-request-detection-method-operand + --alert-rule-post-request-detection-method-type string alert-rule-post-request-detection-method-type + --alert-rule-post-request-detection-method-warning-threshold string Stream alert rule metric warning threshold + --alert-rule-post-request-detection-method-window-size string Stream alert rule metric window size + --alert-rule-post-request-enabled Stream alert rule enabled status + --alert-rule-post-request-metric-selector-additional-properties string alert-rule-post-request-metric-selector-additional-properties (JSON) + --alert-rule-post-request-metric-selector-include string Stream alert rule filtered by metric name (JSON array) + --alert-rule-post-request-name string Customer-provided stream name + --alert-rule-post-request-resource-selector-additional-properties string alert-rule-post-request-resource-selector-additional-properties (JSON) + --alert-rule-post-request-resource-selector-include /fabric/v4/ports/ ### Supported metric names to use on filters with property /subject: * /fabric/v4/ports/ - port metrics * `/fabric/v4/connections/` - connection metrics * `/fabric/v4/metros/` - metro latency metrics (JSON array) + --alert-rule-post-request-type string alert-rule-post-request-type + -h, --help help for create-stream-alert-rules + --request string JSON payload for additional optional fields not exposed as flags + --stream-id string Stream UUID (required) +``` + +### 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 fabricv4 stream-alert-rules](equinix_fabricv4_stream-alert-rules.md) - Manage stream-alert-rules resources + diff --git a/docs/equinix_fabricv4_stream-alert-rules_delete-stream-alert-rule-by-uuid.md b/docs/equinix_fabricv4_stream-alert-rules_delete-stream-alert-rule-by-uuid.md new file mode 100644 index 0000000..1aaba77 --- /dev/null +++ b/docs/equinix_fabricv4_stream-alert-rules_delete-stream-alert-rule-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 stream-alert-rules delete-stream-alert-rule-by-uuid + +Update Stream Alert Rules + +### Synopsis + +This API provides capability to delete a user's stream alert rule + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 stream-alert-rules delete-stream-alert-rule-by-uuid [flags] +``` + +### Options + +``` + --alert-rule-id string alert rule UUID (required) + -h, --help help for delete-stream-alert-rule-by-uuid + --request string JSON payload for request body fields + --stream-id string Stream UUID (required) +``` + +### 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 fabricv4 stream-alert-rules](equinix_fabricv4_stream-alert-rules.md) - Manage stream-alert-rules resources + diff --git a/docs/equinix_fabricv4_stream-alert-rules_get-stream-alert-rule-by-uuid.md b/docs/equinix_fabricv4_stream-alert-rules_get-stream-alert-rule-by-uuid.md new file mode 100644 index 0000000..171307f --- /dev/null +++ b/docs/equinix_fabricv4_stream-alert-rules_get-stream-alert-rule-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 stream-alert-rules get-stream-alert-rule-by-uuid + +Get Stream Alert Rules + +### Synopsis + +This API provides capability to get user's stream alert rules + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 stream-alert-rules get-stream-alert-rule-by-uuid [flags] +``` + +### Options + +``` + --alert-rule-id string alert rule UUID (required) + -h, --help help for get-stream-alert-rule-by-uuid + --request string JSON payload for request body fields + --stream-id string Stream UUID (required) +``` + +### 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 fabricv4 stream-alert-rules](equinix_fabricv4_stream-alert-rules.md) - Manage stream-alert-rules resources + diff --git a/docs/equinix_fabricv4_stream-alert-rules_get-stream-alert-rules.md b/docs/equinix_fabricv4_stream-alert-rules_get-stream-alert-rules.md new file mode 100644 index 0000000..537d7b0 --- /dev/null +++ b/docs/equinix_fabricv4_stream-alert-rules_get-stream-alert-rules.md @@ -0,0 +1,36 @@ +## equinix fabricv4 stream-alert-rules get-stream-alert-rules + +Get Stream Alert Rules + +### Synopsis + +This API provides capability to retrieve stream alert rules + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 stream-alert-rules get-stream-alert-rules [flags] +``` + +### Options + +``` + -h, --help help for get-stream-alert-rules + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --stream-id string Stream UUID (required) +``` + +### 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 fabricv4 stream-alert-rules](equinix_fabricv4_stream-alert-rules.md) - Manage stream-alert-rules resources + diff --git a/docs/equinix_fabricv4_stream-alert-rules_update-stream-alert-rule-by-uuid.md b/docs/equinix_fabricv4_stream-alert-rules_update-stream-alert-rule-by-uuid.md new file mode 100644 index 0000000..4a3b24d --- /dev/null +++ b/docs/equinix_fabricv4_stream-alert-rules_update-stream-alert-rule-by-uuid.md @@ -0,0 +1,50 @@ +## equinix fabricv4 stream-alert-rules update-stream-alert-rule-by-uuid + +Update Stream Alert Rules + +### Synopsis + +This API provides capability to update a user's stream alert rule + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 stream-alert-rules update-stream-alert-rule-by-uuid [flags] +``` + +### Options + +``` + --alert-rule-id string alert rule UUID (required) + --alert-rule-put-request-additional-properties string alert-rule-put-request-additional-properties (JSON) + --alert-rule-put-request-description string Customer-provided stream description + --alert-rule-put-request-detection-method-additional-properties string alert-rule-put-request-detection-method-additional-properties (JSON) + --alert-rule-put-request-detection-method-critical-threshold string Stream alert rule metric critical threshold + --alert-rule-put-request-detection-method-operand string alert-rule-put-request-detection-method-operand + --alert-rule-put-request-detection-method-type string alert-rule-put-request-detection-method-type + --alert-rule-put-request-detection-method-warning-threshold string Stream alert rule metric warning threshold + --alert-rule-put-request-detection-method-window-size string Stream alert rule metric window size + --alert-rule-put-request-enabled Stream alert rule enabled status + --alert-rule-put-request-metric-selector-additional-properties string alert-rule-put-request-metric-selector-additional-properties (JSON) + --alert-rule-put-request-metric-selector-include string Stream alert rule filtered by metric name (JSON array) + --alert-rule-put-request-name string Customer-provided stream name + --alert-rule-put-request-resource-selector-additional-properties string alert-rule-put-request-resource-selector-additional-properties (JSON) + --alert-rule-put-request-resource-selector-include /fabric/v4/ports/ ### Supported metric names to use on filters with property /subject: * /fabric/v4/ports/ - port metrics * `/fabric/v4/connections/` - connection metrics * `/fabric/v4/metros/` - metro latency metrics (JSON array) + --alert-rule-put-request-type string alert-rule-put-request-type + -h, --help help for update-stream-alert-rule-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --stream-id string Stream UUID (required) +``` + +### 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 fabricv4 stream-alert-rules](equinix_fabricv4_stream-alert-rules.md) - Manage stream-alert-rules resources + diff --git a/docs/equinix_fabricv4_stream-subscriptions.md b/docs/equinix_fabricv4_stream-subscriptions.md new file mode 100644 index 0000000..eda59f9 --- /dev/null +++ b/docs/equinix_fabricv4_stream-subscriptions.md @@ -0,0 +1,31 @@ +## equinix fabricv4 stream-subscriptions + +Manage stream-subscriptions resources + +### Synopsis + +Commands for managing stream-subscriptions resources in the API + +### Options + +``` + -h, --help help for stream-subscriptions +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 stream-subscriptions create-stream-subscriptions](equinix_fabricv4_stream-subscriptions_create-stream-subscriptions.md) - Create Subscription +* [equinix fabricv4 stream-subscriptions delete-stream-subscription-by-uuid](equinix_fabricv4_stream-subscriptions_delete-stream-subscription-by-uuid.md) - Delete Subscription +* [equinix fabricv4 stream-subscriptions get-stream-subscription-by-uuid](equinix_fabricv4_stream-subscriptions_get-stream-subscription-by-uuid.md) - Get Subscription +* [equinix fabricv4 stream-subscriptions get-stream-subscriptions](equinix_fabricv4_stream-subscriptions_get-stream-subscriptions.md) - Get Subscriptions +* [equinix fabricv4 stream-subscriptions update-stream-subscription-by-uuid](equinix_fabricv4_stream-subscriptions_update-stream-subscription-by-uuid.md) - Update Subscription + diff --git a/docs/equinix_fabricv4_stream-subscriptions_create-stream-subscriptions.md b/docs/equinix_fabricv4_stream-subscriptions_create-stream-subscriptions.md new file mode 100644 index 0000000..acf37d6 --- /dev/null +++ b/docs/equinix_fabricv4_stream-subscriptions_create-stream-subscriptions.md @@ -0,0 +1,54 @@ +## equinix fabricv4 stream-subscriptions create-stream-subscriptions + +Create Subscription + +### Synopsis + +This API provides capability to create user's Stream Subscriptions + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 stream-subscriptions create-stream-subscriptions [flags] +``` + +### Options + +``` + -h, --help help for create-stream-subscriptions + --request string JSON payload for additional optional fields not exposed as flags + --stream-id string Stream UUID (required) + --stream-subscription-post-request-additional-properties string stream-subscription-post-request-additional-properties (JSON) + --stream-subscription-post-request-description string Customer-provided stream subscription description + --stream-subscription-post-request-enabled Stream subscription enabled status + --stream-subscription-post-request-event-selector-additional-properties string stream-subscription-post-request-event-selector-additional-properties (JSON) + --stream-subscription-post-request-event-selector-except string stream-subscription-post-request-event-selector-except (JSON array) + --stream-subscription-post-request-event-selector-include string stream-subscription-post-request-event-selector-include (JSON array) + --stream-subscription-post-request-metric-selector-additional-properties string stream-subscription-post-request-metric-selector-additional-properties (JSON) + --stream-subscription-post-request-metric-selector-except string stream-subscription-post-request-metric-selector-except (JSON array) + --stream-subscription-post-request-metric-selector-include string stream-subscription-post-request-metric-selector-include (JSON array) + --stream-subscription-post-request-name string Customer-provided stream subscription name + --stream-subscription-post-request-sink-additional-properties string stream-subscription-post-request-sink-additional-properties (JSON) + --stream-subscription-post-request-sink-batch-enabled batch mode on/off + --stream-subscription-post-request-sink-batch-size-max int maximum batch size + --stream-subscription-post-request-sink-batch-wait-time-max int maximum batch waiting time + --stream-subscription-post-request-sink-credential string stream-subscription-post-request-sink-credential (JSON) + --stream-subscription-post-request-sink-host string sink host + --stream-subscription-post-request-sink-settings string stream-subscription-post-request-sink-settings (JSON) + --stream-subscription-post-request-sink-type string stream-subscription-post-request-sink-type + --stream-subscription-post-request-sink-uri string any publicly reachable http endpoint + --stream-subscription-post-request-type string stream-subscription-post-request-type +``` + +### 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 fabricv4 stream-subscriptions](equinix_fabricv4_stream-subscriptions.md) - Manage stream-subscriptions resources + diff --git a/docs/equinix_fabricv4_stream-subscriptions_delete-stream-subscription-by-uuid.md b/docs/equinix_fabricv4_stream-subscriptions_delete-stream-subscription-by-uuid.md new file mode 100644 index 0000000..409f251 --- /dev/null +++ b/docs/equinix_fabricv4_stream-subscriptions_delete-stream-subscription-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 stream-subscriptions delete-stream-subscription-by-uuid + +Delete Subscription + +### Synopsis + +This API provides capability to delete user's Stream Subscriptions + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 stream-subscriptions delete-stream-subscription-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-stream-subscription-by-uuid + --request string JSON payload for request body fields + --stream-id string Stream UUID (required) + --subscription-id string Stream Subscription UUID (required) +``` + +### 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 fabricv4 stream-subscriptions](equinix_fabricv4_stream-subscriptions.md) - Manage stream-subscriptions resources + diff --git a/docs/equinix_fabricv4_stream-subscriptions_get-stream-subscription-by-uuid.md b/docs/equinix_fabricv4_stream-subscriptions_get-stream-subscription-by-uuid.md new file mode 100644 index 0000000..cf7d3a1 --- /dev/null +++ b/docs/equinix_fabricv4_stream-subscriptions_get-stream-subscription-by-uuid.md @@ -0,0 +1,35 @@ +## equinix fabricv4 stream-subscriptions get-stream-subscription-by-uuid + +Get Subscription + +### Synopsis + +This API provides capability to delete user's get Stream Subscriptions + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 stream-subscriptions get-stream-subscription-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-stream-subscription-by-uuid + --request string JSON payload for request body fields + --stream-id string Stream UUID (required) + --subscription-id string Stream Subscription UUID (required) +``` + +### 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 fabricv4 stream-subscriptions](equinix_fabricv4_stream-subscriptions.md) - Manage stream-subscriptions resources + diff --git a/docs/equinix_fabricv4_stream-subscriptions_get-stream-subscriptions.md b/docs/equinix_fabricv4_stream-subscriptions_get-stream-subscriptions.md new file mode 100644 index 0000000..b138d71 --- /dev/null +++ b/docs/equinix_fabricv4_stream-subscriptions_get-stream-subscriptions.md @@ -0,0 +1,36 @@ +## equinix fabricv4 stream-subscriptions get-stream-subscriptions + +Get Subscriptions + +### Synopsis + +This API provides capability to retrieve stream subscriptions + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 stream-subscriptions get-stream-subscriptions [flags] +``` + +### Options + +``` + -h, --help help for get-stream-subscriptions + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --stream-id string Stream UUID (required) +``` + +### 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 fabricv4 stream-subscriptions](equinix_fabricv4_stream-subscriptions.md) - Manage stream-subscriptions resources + diff --git a/docs/equinix_fabricv4_stream-subscriptions_update-stream-subscription-by-uuid.md b/docs/equinix_fabricv4_stream-subscriptions_update-stream-subscription-by-uuid.md new file mode 100644 index 0000000..dd1df83 --- /dev/null +++ b/docs/equinix_fabricv4_stream-subscriptions_update-stream-subscription-by-uuid.md @@ -0,0 +1,57 @@ +## equinix fabricv4 stream-subscriptions update-stream-subscription-by-uuid + +Update Subscription + +### Synopsis + +This API provides capability to update user's Stream Subscriptions + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 stream-subscriptions update-stream-subscription-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for update-stream-subscription-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --stream-id string Stream UUID (required) + --stream-subscription-put-request-additional-properties string stream-subscription-put-request-additional-properties (JSON) + --stream-subscription-put-request-description string Customer-provided stream subscription description + --stream-subscription-put-request-enabled Stream subscription enabled status + --stream-subscription-put-request-event-selector-additional-properties string stream-subscription-put-request-event-selector-additional-properties (JSON) + --stream-subscription-put-request-event-selector-except string stream-subscription-put-request-event-selector-except (JSON array) + --stream-subscription-put-request-event-selector-include string stream-subscription-put-request-event-selector-include (JSON array) + --stream-subscription-put-request-filters-additional-properties string stream-subscription-put-request-filters-additional-properties (JSON) + --stream-subscription-put-request-filters-and string stream-subscription-put-request-filters-and (JSON array) + --stream-subscription-put-request-metric-selector-additional-properties string stream-subscription-put-request-metric-selector-additional-properties (JSON) + --stream-subscription-put-request-metric-selector-except string stream-subscription-put-request-metric-selector-except (JSON array) + --stream-subscription-put-request-metric-selector-include string stream-subscription-put-request-metric-selector-include (JSON array) + --stream-subscription-put-request-name string Customer-provided stream subscription name + --stream-subscription-put-request-sink-additional-properties string stream-subscription-put-request-sink-additional-properties (JSON) + --stream-subscription-put-request-sink-batch-enabled batch mode on/off + --stream-subscription-put-request-sink-batch-size-max int maximum batch size + --stream-subscription-put-request-sink-batch-wait-time-max int maximum batch waiting time + --stream-subscription-put-request-sink-credential string stream-subscription-put-request-sink-credential (JSON) + --stream-subscription-put-request-sink-host string sink host + --stream-subscription-put-request-sink-settings string stream-subscription-put-request-sink-settings (JSON) + --stream-subscription-put-request-sink-type string stream-subscription-put-request-sink-type + --stream-subscription-put-request-sink-uri string any publicly reachable http endpoint + --stream-subscription-put-request-type string stream-subscription-put-request-type + --subscription-id string Stream Subscription UUID (required) +``` + +### 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 fabricv4 stream-subscriptions](equinix_fabricv4_stream-subscriptions.md) - Manage stream-subscriptions resources + diff --git a/docs/equinix_fabricv4_streams.md b/docs/equinix_fabricv4_streams.md new file mode 100644 index 0000000..09ae2ae --- /dev/null +++ b/docs/equinix_fabricv4_streams.md @@ -0,0 +1,35 @@ +## equinix fabricv4 streams + +Manage streams resources + +### Synopsis + +Commands for managing streams resources in the API + +### Options + +``` + -h, --help help for streams +``` + +### 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 fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 streams create-streams](equinix_fabricv4_streams_create-streams.md) - Create Stream +* [equinix fabricv4 streams delete-stream-asset-by-uuid](equinix_fabricv4_streams_delete-stream-asset-by-uuid.md) - Detach Asset +* [equinix fabricv4 streams delete-stream-by-uuid](equinix_fabricv4_streams_delete-stream-by-uuid.md) - Delete Stream +* [equinix fabricv4 streams get-stream-asset-by-uuid](equinix_fabricv4_streams_get-stream-asset-by-uuid.md) - Get Asset +* [equinix fabricv4 streams get-stream-by-uuid](equinix_fabricv4_streams_get-stream-by-uuid.md) - Get Stream +* [equinix fabricv4 streams get-streams](equinix_fabricv4_streams_get-streams.md) - Get Streams +* [equinix fabricv4 streams get-streams-assets](equinix_fabricv4_streams_get-streams-assets.md) - Get Assets +* [equinix fabricv4 streams update-stream-asset-by-uuid](equinix_fabricv4_streams_update-stream-asset-by-uuid.md) - Attach Asset +* [equinix fabricv4 streams update-stream-by-uuid](equinix_fabricv4_streams_update-stream-by-uuid.md) - Update Stream + diff --git a/docs/equinix_fabricv4_streams_create-streams.md b/docs/equinix_fabricv4_streams_create-streams.md new file mode 100644 index 0000000..be05d31 --- /dev/null +++ b/docs/equinix_fabricv4_streams_create-streams.md @@ -0,0 +1,39 @@ +## equinix fabricv4 streams create-streams + +Create Stream + +### Synopsis + +This API provides capability to create user's stream + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 streams create-streams [flags] +``` + +### Options + +``` + -h, --help help for create-streams + --request string JSON payload for additional optional fields not exposed as flags + --stream-post-request-additional-properties string stream-post-request-additional-properties (JSON) + --stream-post-request-description string Customer-provided stream description + --stream-post-request-name string Customer-provided stream name + --stream-post-request-project-additional-properties string stream-post-request-project-additional-properties (JSON) + --stream-post-request-project-project-id string Subscriber-assigned project ID + --stream-post-request-type string stream-post-request-type +``` + +### 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 fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources + diff --git a/docs/equinix_fabricv4_streams_delete-stream-asset-by-uuid.md b/docs/equinix_fabricv4_streams_delete-stream-asset-by-uuid.md new file mode 100644 index 0000000..57d8421 --- /dev/null +++ b/docs/equinix_fabricv4_streams_delete-stream-asset-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 streams delete-stream-asset-by-uuid + +Detach Asset + +### Synopsis + +This API provides capability to detach an asset from a stream + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 streams delete-stream-asset-by-uuid [flags] +``` + +### Options + +``` + --asset string asset (required) + --asset-id string asset UUID (required) + -h, --help help for delete-stream-asset-by-uuid + --request string JSON payload for request body fields + --stream-id string Stream UUID (required) +``` + +### 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 fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources + diff --git a/docs/equinix_fabricv4_streams_delete-stream-by-uuid.md b/docs/equinix_fabricv4_streams_delete-stream-by-uuid.md new file mode 100644 index 0000000..398826a --- /dev/null +++ b/docs/equinix_fabricv4_streams_delete-stream-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 streams delete-stream-by-uuid + +Delete Stream + +### Synopsis + +This API provides capability to delete user's stream + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 streams delete-stream-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-stream-by-uuid + --request string JSON payload for request body fields + --stream-id string Stream UUID (required) +``` + +### 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 fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources + diff --git a/docs/equinix_fabricv4_streams_get-stream-asset-by-uuid.md b/docs/equinix_fabricv4_streams_get-stream-asset-by-uuid.md new file mode 100644 index 0000000..26ca6c7 --- /dev/null +++ b/docs/equinix_fabricv4_streams_get-stream-asset-by-uuid.md @@ -0,0 +1,36 @@ +## equinix fabricv4 streams get-stream-asset-by-uuid + +Get Asset + +### Synopsis + +This API provides capability to get user's assets attached to a stream + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 streams get-stream-asset-by-uuid [flags] +``` + +### Options + +``` + --asset string asset (required) + --asset-id string asset UUID (required) + -h, --help help for get-stream-asset-by-uuid + --request string JSON payload for request body fields + --stream-id string Stream UUID (required) +``` + +### 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 fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources + diff --git a/docs/equinix_fabricv4_streams_get-stream-by-uuid.md b/docs/equinix_fabricv4_streams_get-stream-by-uuid.md new file mode 100644 index 0000000..dfc32a1 --- /dev/null +++ b/docs/equinix_fabricv4_streams_get-stream-by-uuid.md @@ -0,0 +1,34 @@ +## equinix fabricv4 streams get-stream-by-uuid + +Get Stream + +### Synopsis + +This API provides capability to get user's stream + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 streams get-stream-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-stream-by-uuid + --request string JSON payload for request body fields + --stream-id string Stream UUID (required) +``` + +### 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 fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources + diff --git a/docs/equinix_fabricv4_streams_get-streams-assets.md b/docs/equinix_fabricv4_streams_get-streams-assets.md new file mode 100644 index 0000000..02eb96d --- /dev/null +++ b/docs/equinix_fabricv4_streams_get-streams-assets.md @@ -0,0 +1,42 @@ +## equinix fabricv4 streams get-streams-assets + +Get Assets + +### Synopsis + +This API provides capability to retrieve stream assets + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 streams get-streams-assets [flags] +``` + +### Options + +``` + -h, --help help for get-streams-assets + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --stream-asset-search-request-additional-properties string stream-asset-search-request-additional-properties (JSON) + --stream-asset-search-request-filter-additional-properties string stream-asset-search-request-filter-additional-properties (JSON) + --stream-asset-search-request-filter-and string stream-asset-search-request-filter-and (JSON array) + --stream-asset-search-request-pagination-additional-properties string stream-asset-search-request-pagination-additional-properties (JSON) + --stream-asset-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --stream-asset-search-request-pagination-offset int Index of the first element. + --stream-asset-search-request-sort string stream-asset-search-request-sort (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 fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources + diff --git a/docs/equinix_fabricv4_streams_get-streams.md b/docs/equinix_fabricv4_streams_get-streams.md new file mode 100644 index 0000000..e6206be --- /dev/null +++ b/docs/equinix_fabricv4_streams_get-streams.md @@ -0,0 +1,35 @@ +## equinix fabricv4 streams get-streams + +Get Streams + +### Synopsis + +This API provides capability to retrieve streams + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 streams get-streams [flags] +``` + +### Options + +``` + -h, --help help for get-streams + --limit int limit field + --offset int offset 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 fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources + diff --git a/docs/equinix_fabricv4_streams_update-stream-asset-by-uuid.md b/docs/equinix_fabricv4_streams_update-stream-asset-by-uuid.md new file mode 100644 index 0000000..d0458e2 --- /dev/null +++ b/docs/equinix_fabricv4_streams_update-stream-asset-by-uuid.md @@ -0,0 +1,38 @@ +## equinix fabricv4 streams update-stream-asset-by-uuid + +Attach Asset + +### Synopsis + +This API provides capability to attach an asset to a stream + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 streams update-stream-asset-by-uuid [flags] +``` + +### Options + +``` + --asset string asset (required) + --asset-id string asset UUID (required) + -h, --help help for update-stream-asset-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --stream-asset-put-request-additional-properties string stream-asset-put-request-additional-properties (JSON) + --stream-asset-put-request-metrics-enabled enable metric + --stream-id string Stream UUID (required) +``` + +### 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 fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources + diff --git a/docs/equinix_fabricv4_streams_update-stream-by-uuid.md b/docs/equinix_fabricv4_streams_update-stream-by-uuid.md new file mode 100644 index 0000000..b0ebbe8 --- /dev/null +++ b/docs/equinix_fabricv4_streams_update-stream-by-uuid.md @@ -0,0 +1,37 @@ +## equinix fabricv4 streams update-stream-by-uuid + +Update Stream + +### Synopsis + +This API provides capability to update user's stream + +Use --request flag to provide optional JSON payload fields. + +``` +equinix fabricv4 streams update-stream-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for update-stream-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --stream-id string Stream UUID (required) + --stream-put-request-additional-properties string stream-put-request-additional-properties (JSON) + --stream-put-request-description string Customer-provided stream description + --stream-put-request-name string Customer-provided stream name +``` + +### 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 fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources + diff --git a/docs/equinix_lookupv2.md b/docs/equinix_lookupv2.md new file mode 100644 index 0000000..0377b49 --- /dev/null +++ b/docs/equinix_lookupv2.md @@ -0,0 +1,30 @@ +## equinix lookupv2 + +Manage Equinix lookupv2 resources + +### Synopsis + +Commands for managing Equinix lookupv2 resources. + +The lookupv2 commands are dynamically generated based on the lookupv2 API client, +providing access to all available API services. + +### Options + +``` + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") + -h, --help help for lookupv2 +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) +``` + +### SEE ALSO + +* [equinix](equinix.md) - Equinix CLI +* [equinix lookupv2 lookup](equinix_lookupv2_lookup.md) - Manage lookup resources + diff --git a/docs/equinix_lookupv2_lookup.md b/docs/equinix_lookupv2_lookup.md new file mode 100644 index 0000000..1169c2e --- /dev/null +++ b/docs/equinix_lookupv2_lookup.md @@ -0,0 +1,31 @@ +## equinix lookupv2 lookup + +Manage lookup resources + +### Synopsis + +Commands for managing lookup resources in the API + +### Options + +``` + -h, --help help for lookup +``` + +### 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 lookupv2](equinix_lookupv2.md) - Manage Equinix lookupv2 resources +* [equinix lookupv2 lookup get-locations-by-permission-code](equinix_lookupv2_lookup_get-locations-by-permission-code.md) - Get Locations by permission code +* [equinix lookupv2 lookup retrieve-all-patch-panels](equinix_lookupv2_lookup_retrieve-all-patch-panels.md) - Retrieve all patch panels +* [equinix lookupv2 lookup retrieve-list-of-connection-services](equinix_lookupv2_lookup_retrieve-list-of-connection-services.md) - Retrieve list of connection services +* [equinix lookupv2 lookup retrieve-list-of-providers](equinix_lookupv2_lookup_retrieve-list-of-providers.md) - Retrieve list of providers +* [equinix lookupv2 lookup retrieve-patch-panel-details](equinix_lookupv2_lookup_retrieve-patch-panel-details.md) - Retrieve patch panel details + diff --git a/docs/equinix_lookupv2_lookup_get-locations-by-permission-code.md b/docs/equinix_lookupv2_lookup_get-locations-by-permission-code.md new file mode 100644 index 0000000..91251fd --- /dev/null +++ b/docs/equinix_lookupv2_lookup_get-locations-by-permission-code.md @@ -0,0 +1,39 @@ +## equinix lookupv2 lookup get-locations-by-permission-code + +Get Locations by permission code + +### Synopsis + +This method retrieves all the user’s IBX locations, accounts, cages and cabinets information according to their ordering permission. This includes A-side and Z-side location information for a cross connect order. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix lookupv2 lookup get-locations-by-permission-code [flags] +``` + +### Options + +``` + --a-side-ibx string a-side-ibx field + --connection-service string connection-service field + --details details field + -h, --help help for get-locations-by-permission-code + --ibxs string ibxs field (JSON or string) + --permission-code string permission-code field + --provider-account-number string provider-account-number 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 lookupv2 lookup](equinix_lookupv2_lookup.md) - Manage lookup resources + diff --git a/docs/equinix_lookupv2_lookup_retrieve-all-patch-panels.md b/docs/equinix_lookupv2_lookup_retrieve-all-patch-panels.md new file mode 100644 index 0000000..21c5d3a --- /dev/null +++ b/docs/equinix_lookupv2_lookup_retrieve-all-patch-panels.md @@ -0,0 +1,37 @@ +## equinix lookupv2 lookup retrieve-all-patch-panels + +Retrieve all patch panels + +### Synopsis + +This method retrieves all available patch panels associated with a cabinet for a user with cross connects ordering permission. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix lookupv2 lookup retrieve-all-patch-panels [flags] +``` + +### Options + +``` + --a-side-ibx string a-side-ibx field + --account-number string account-number field + --cabinet-id string cabinet-id field + -h, --help help for retrieve-all-patch-panels + --provider-account-number string provider-account-number 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 lookupv2 lookup](equinix_lookupv2_lookup.md) - Manage lookup resources + diff --git a/docs/equinix_lookupv2_lookup_retrieve-list-of-connection-services.md b/docs/equinix_lookupv2_lookup_retrieve-list-of-connection-services.md new file mode 100644 index 0000000..08bb4da --- /dev/null +++ b/docs/equinix_lookupv2_lookup_retrieve-list-of-connection-services.md @@ -0,0 +1,34 @@ +## equinix lookupv2 lookup retrieve-list-of-connection-services + +Retrieve list of connection services + +### Synopsis + +This method retrieves a list of supported connection services such as media types, protocol types, connector types and circuit counts. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix lookupv2 lookup retrieve-list-of-connection-services [flags] +``` + +### Options + +``` + -h, --help help for retrieve-list-of-connection-services + --ibx string ibx 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 lookupv2 lookup](equinix_lookupv2_lookup.md) - Manage lookup resources + diff --git a/docs/equinix_lookupv2_lookup_retrieve-list-of-providers.md b/docs/equinix_lookupv2_lookup_retrieve-list-of-providers.md new file mode 100644 index 0000000..62b8244 --- /dev/null +++ b/docs/equinix_lookupv2_lookup_retrieve-list-of-providers.md @@ -0,0 +1,35 @@ +## equinix lookupv2 lookup retrieve-list-of-providers + +Retrieve list of providers + +### Synopsis + +This method retrieves all available cross connect service providers to a user with cross connects ordering permission. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix lookupv2 lookup retrieve-list-of-providers [flags] +``` + +### Options + +``` + --account-number string account-number field + --cage-id string cage-id field + -h, --help help for retrieve-list-of-providers + --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 lookupv2 lookup](equinix_lookupv2_lookup.md) - Manage lookup resources + diff --git a/docs/equinix_lookupv2_lookup_retrieve-patch-panel-details.md b/docs/equinix_lookupv2_lookup_retrieve-patch-panel-details.md new file mode 100644 index 0000000..c1cfbe1 --- /dev/null +++ b/docs/equinix_lookupv2_lookup_retrieve-patch-panel-details.md @@ -0,0 +1,37 @@ +## equinix lookupv2 lookup retrieve-patch-panel-details + +Retrieve patch panel details + +### Synopsis + +This method retrieves details of a patch panel by its ID to a user with cross connects ordering permission. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix lookupv2 lookup retrieve-patch-panel-details [flags] +``` + +### Options + +``` + --a-side-ibx string a-side-ibx field + --account-number string account-number field + -h, --help help for retrieve-patch-panel-details + --patch-panel-id string ID of patch panel (required) + --provider-account-number string provider-account-number 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 lookupv2 lookup](equinix_lookupv2_lookup.md) - Manage lookup resources + diff --git a/docs/equinix_metalv1.md b/docs/equinix_metalv1.md new file mode 100644 index 0000000..f70658b --- /dev/null +++ b/docs/equinix_metalv1.md @@ -0,0 +1,68 @@ +## equinix metalv1 + +Manage Equinix metalv1 resources + +### Synopsis + +Commands for managing Equinix metalv1 resources. + +The metalv1 commands are dynamically generated based on the metalv1 API client, +providing access to all available API services. + +### Options + +``` + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") + -h, --help help for metalv1 +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) +``` + +### SEE ALSO + +* [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 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 +* [equinix metalv1 emails](equinix_metalv1_emails.md) - Manage emails resources +* [equinix metalv1 events](equinix_metalv1_events.md) - Manage events resources +* [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 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 +* [equinix metalv1 metros](equinix_metalv1_metros.md) - Manage metros resources +* [equinix metalv1 operating-systems](equinix_metalv1_operating-systems.md) - Manage operating-systems resources +* [equinix metalv1 organizations](equinix_metalv1_organizations.md) - Manage organizations resources +* [equinix metalv1 password-reset-tokens](equinix_metalv1_password-reset-tokens.md) - Manage password-reset-tokens resources +* [equinix metalv1 payment-methods](equinix_metalv1_payment-methods.md) - Manage payment-methods resources +* [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 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 +* [equinix metalv1 usages](equinix_metalv1_usages.md) - Manage usages resources +* [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 + diff --git a/docs/equinix_metalv1_authentication.md b/docs/equinix_metalv1_authentication.md new file mode 100644 index 0000000..147d441 --- /dev/null +++ b/docs/equinix_metalv1_authentication.md @@ -0,0 +1,32 @@ +## equinix metalv1 authentication + +Manage authentication resources + +### Synopsis + +Commands for managing authentication resources in the API + +### Options + +``` + -h, --help help for authentication +``` + +### 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 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. + diff --git a/docs/equinix_metalv1_authentication_create-a-p-i-key.md b/docs/equinix_metalv1_authentication_create-a-p-i-key.md new file mode 100644 index 0000000..6fba5c5 --- /dev/null +++ b/docs/equinix_metalv1_authentication_create-a-p-i-key.md @@ -0,0 +1,37 @@ +## equinix metalv1 authentication create-a-p-i-key + +Create an API key + +### Synopsis + +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] +``` + +### Options + +``` + --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 + --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 authentication](equinix_metalv1_authentication.md) - Manage authentication resources + diff --git a/docs/equinix_metalv1_authentication_create-project-a-p-i-key.md b/docs/equinix_metalv1_authentication_create-project-a-p-i-key.md new file mode 100644 index 0000000..00f7c12 --- /dev/null +++ b/docs/equinix_metalv1_authentication_create-project-a-p-i-key.md @@ -0,0 +1,38 @@ +## equinix metalv1 authentication create-project-a-p-i-key + +Create an API key for a project. + +### Synopsis + +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] +``` + +### Options + +``` + --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 + --id string Project 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 authentication](equinix_metalv1_authentication.md) - Manage authentication resources + diff --git a/docs/equinix_metalv1_authentication_delete-a-p-i-key.md b/docs/equinix_metalv1_authentication_delete-a-p-i-key.md new file mode 100644 index 0000000..5e098ac --- /dev/null +++ b/docs/equinix_metalv1_authentication_delete-a-p-i-key.md @@ -0,0 +1,34 @@ +## equinix metalv1 authentication delete-a-p-i-key + +Delete the API key + +### Synopsis + +Deletes the API key. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 authentication delete-a-p-i-key [flags] +``` + +### Options + +``` + -h, --help help for delete-a-p-i-key + --id string API 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 authentication](equinix_metalv1_authentication.md) - Manage authentication resources + diff --git a/docs/equinix_metalv1_authentication_delete-user-a-p-i-key.md b/docs/equinix_metalv1_authentication_delete-user-a-p-i-key.md new file mode 100644 index 0000000..e4e89e1 --- /dev/null +++ b/docs/equinix_metalv1_authentication_delete-user-a-p-i-key.md @@ -0,0 +1,34 @@ +## equinix metalv1 authentication delete-user-a-p-i-key + +Delete the API key + +### Synopsis + +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] +``` + +### Options + +``` + -h, --help help for delete-user-a-p-i-key + --id string API 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 authentication](equinix_metalv1_authentication.md) - Manage authentication resources + diff --git a/docs/equinix_metalv1_authentication_find-a-p-i-keys.md b/docs/equinix_metalv1_authentication_find-a-p-i-keys.md new file mode 100644 index 0000000..8a5b2b0 --- /dev/null +++ b/docs/equinix_metalv1_authentication_find-a-p-i-keys.md @@ -0,0 +1,35 @@ +## equinix metalv1 authentication find-a-p-i-keys + +Retrieve all user API keys + +### Synopsis + +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] +``` + +### Options + +``` + -h, --help help for find-a-p-i-keys + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --search string search 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 authentication](equinix_metalv1_authentication.md) - Manage authentication resources + diff --git a/docs/equinix_metalv1_authentication_find-project-a-p-i-keys.md b/docs/equinix_metalv1_authentication_find-project-a-p-i-keys.md new file mode 100644 index 0000000..fdcb589 --- /dev/null +++ b/docs/equinix_metalv1_authentication_find-project-a-p-i-keys.md @@ -0,0 +1,35 @@ +## equinix metalv1 authentication find-project-a-p-i-keys + +Retrieve all API keys for the project. + +### Synopsis + +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] +``` + +### Options + +``` + -h, --help help for find-project-a-p-i-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 +``` + +### 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 authentication](equinix_metalv1_authentication.md) - Manage authentication resources + diff --git a/docs/equinix_metalv1_b-g-p.md b/docs/equinix_metalv1_b-g-p.md new file mode 100644 index 0000000..a412aed --- /dev/null +++ b/docs/equinix_metalv1_b-g-p.md @@ -0,0 +1,33 @@ +## 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 new file mode 100644 index 0000000..1d83e14 --- /dev/null +++ b/docs/equinix_metalv1_b-g-p_delete-bgp-session.md @@ -0,0 +1,37 @@ +## 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-bgp-config-by-project.md b/docs/equinix_metalv1_b-g-p_find-bgp-config-by-project.md new file mode 100644 index 0000000..7e0cb35 --- /dev/null +++ b/docs/equinix_metalv1_b-g-p_find-bgp-config-by-project.md @@ -0,0 +1,38 @@ +## equinix metalv1 b-g-p find-bgp-config-by-project + +Execute find-bgp-config-by-project operation + +### Synopsis + +Execute the find-bgp-config-by-project 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-bgp-config-by-project [flags] +``` + +### Options + +``` + -h, --help help for find-bgp-config-by-project + --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 b-g-p](equinix_metalv1_b-g-p.md) - Manage b-g-p resources + diff --git a/docs/equinix_metalv1_b-g-p_find-bgp-session-by-id.md b/docs/equinix_metalv1_b-g-p_find-bgp-session-by-id.md new file mode 100644 index 0000000..60024de --- /dev/null +++ b/docs/equinix_metalv1_b-g-p_find-bgp-session-by-id.md @@ -0,0 +1,38 @@ +## equinix metalv1 b-g-p find-bgp-session-by-id + +Execute find-bgp-session-by-id operation + +### Synopsis + +Execute the find-bgp-session-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 b-g-p find-bgp-session-by-id [flags] +``` + +### Options + +``` + -h, --help help for find-bgp-session-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 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 new file mode 100644 index 0000000..fa0c729 --- /dev/null +++ b/docs/equinix_metalv1_b-g-p_find-global-bgp-ranges.md @@ -0,0 +1,37 @@ +## 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 new file mode 100644 index 0000000..feeb958 --- /dev/null +++ b/docs/equinix_metalv1_b-g-p_find-project-bgp-sessions.md @@ -0,0 +1,37 @@ +## 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_b-g-p_request-bgp-config.md b/docs/equinix_metalv1_b-g-p_request-bgp-config.md new file mode 100644 index 0000000..27b898e --- /dev/null +++ b/docs/equinix_metalv1_b-g-p_request-bgp-config.md @@ -0,0 +1,43 @@ +## equinix metalv1 b-g-p request-bgp-config + +Execute request-bgp-config operation + +### Synopsis + +Execute the request-bgp-config 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 request-bgp-config [flags] +``` + +### Options + +``` + --bgp-config-request-input-additional-properties string bgp-config-request-input-additional-properties (JSON) + --bgp-config-request-input-asn int Autonomous System Number for local BGP deployment. + --bgp-config-request-input-deployment_type string bgp-config-request-input-deployment_type + --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 + --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 b-g-p](equinix_metalv1_b-g-p.md) - Manage b-g-p resources + diff --git a/docs/equinix_metalv1_b-g-p_update-bgp-session.md b/docs/equinix_metalv1_b-g-p_update-bgp-session.md new file mode 100644 index 0000000..22b51f1 --- /dev/null +++ b/docs/equinix_metalv1_b-g-p_update-bgp-session.md @@ -0,0 +1,38 @@ +## equinix metalv1 b-g-p update-bgp-session + +Execute update-bgp-session operation + +### Synopsis + +Execute the update-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 update-bgp-session [flags] +``` + +### Options + +``` + --body body field + -h, --help help for update-bgp-session + --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 b-g-p](equinix_metalv1_b-g-p.md) - Manage b-g-p resources + diff --git a/docs/equinix_metalv1_batches.md b/docs/equinix_metalv1_batches.md new file mode 100644 index 0000000..9e94040 --- /dev/null +++ b/docs/equinix_metalv1_batches.md @@ -0,0 +1,30 @@ +## equinix metalv1 batches + +Manage batches resources + +### Synopsis + +Commands for managing batches resources in the API + +### Options + +``` + -h, --help help for batches +``` + +### 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 batches create-device-batch](equinix_metalv1_batches_create-device-batch.md) - Create a devices batch +* [equinix metalv1 batches delete-batch](equinix_metalv1_batches_delete-batch.md) - Delete the Batch +* [equinix metalv1 batches find-batch-by-id](equinix_metalv1_batches_find-batch-by-id.md) - Retrieve a Batch +* [equinix metalv1 batches find-batches-by-project](equinix_metalv1_batches_find-batches-by-project.md) - Retrieve all batches by project + diff --git a/docs/equinix_metalv1_batches_create-device-batch.md b/docs/equinix_metalv1_batches_create-device-batch.md new file mode 100644 index 0000000..3fc0798 --- /dev/null +++ b/docs/equinix_metalv1_batches_create-device-batch.md @@ -0,0 +1,36 @@ +## equinix metalv1 batches create-device-batch + +Create a devices batch + +### Synopsis + +Creates new devices in batch and provisions them in our datacenter. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 batches create-device-batch [flags] +``` + +### Options + +``` + -h, --help help for create-device-batch + --id string Project UUID (required) + --instances-batch-create-input-additional-properties string instances-batch-create-input-additional-properties (JSON) + --instances-batch-create-input-batches string instances-batch-create-input-batches (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 batches](equinix_metalv1_batches.md) - Manage batches resources + diff --git a/docs/equinix_metalv1_batches_delete-batch.md b/docs/equinix_metalv1_batches_delete-batch.md new file mode 100644 index 0000000..a4b7414 --- /dev/null +++ b/docs/equinix_metalv1_batches_delete-batch.md @@ -0,0 +1,35 @@ +## equinix metalv1 batches delete-batch + +Delete the Batch + +### Synopsis + +Deletes the Batch. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 batches delete-batch [flags] +``` + +### Options + +``` + -h, --help help for delete-batch + --id string Batch UUID (required) + --remove-associated-instances remove-associated-instances 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 batches](equinix_metalv1_batches.md) - Manage batches resources + diff --git a/docs/equinix_metalv1_batches_find-batch-by-id.md b/docs/equinix_metalv1_batches_find-batch-by-id.md new file mode 100644 index 0000000..c506cf4 --- /dev/null +++ b/docs/equinix_metalv1_batches_find-batch-by-id.md @@ -0,0 +1,35 @@ +## equinix metalv1 batches find-batch-by-id + +Retrieve a Batch + +### Synopsis + +Returns a Batch + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 batches find-batch-by-id [flags] +``` + +### Options + +``` + -h, --help help for find-batch-by-id + --id string Batch 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 batches](equinix_metalv1_batches.md) - Manage batches resources + diff --git a/docs/equinix_metalv1_batches_find-batches-by-project.md b/docs/equinix_metalv1_batches_find-batches-by-project.md new file mode 100644 index 0000000..2e48872 --- /dev/null +++ b/docs/equinix_metalv1_batches_find-batches-by-project.md @@ -0,0 +1,35 @@ +## equinix metalv1 batches find-batches-by-project + +Retrieve all batches by project + +### Synopsis + +Returns all batches for the given project + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 batches find-batches-by-project [flags] +``` + +### Options + +``` + -h, --help help for find-batches-by-project + --id string Project 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 batches](equinix_metalv1_batches.md) - Manage batches resources + diff --git a/docs/equinix_metalv1_capacity.md b/docs/equinix_metalv1_capacity.md new file mode 100644 index 0000000..11f0e48 --- /dev/null +++ b/docs/equinix_metalv1_capacity.md @@ -0,0 +1,32 @@ +## equinix metalv1 capacity + +Manage capacity resources + +### Synopsis + +Commands for managing capacity resources in the API + +### Options + +``` + -h, --help help for capacity +``` + +### 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 capacity check-capacity-for-facility](equinix_metalv1_capacity_check-capacity-for-facility.md) - Check capacity +* [equinix metalv1 capacity check-capacity-for-metro](equinix_metalv1_capacity_check-capacity-for-metro.md) - Check capacity for a metro +* [equinix metalv1 capacity find-capacity-for-facility](equinix_metalv1_capacity_find-capacity-for-facility.md) - View capacity +* [equinix metalv1 capacity find-capacity-for-metro](equinix_metalv1_capacity_find-capacity-for-metro.md) - View capacity for metros +* [equinix metalv1 capacity find-organization-capacity-per-facility](equinix_metalv1_capacity_find-organization-capacity-per-facility.md) - View available hardware plans per Facility for given organization +* [equinix metalv1 capacity find-organization-capacity-per-metro](equinix_metalv1_capacity_find-organization-capacity-per-metro.md) - View available hardware plans per Metro for given organization + diff --git a/docs/equinix_metalv1_capacity_check-capacity-for-facility.md b/docs/equinix_metalv1_capacity_check-capacity-for-facility.md new file mode 100644 index 0000000..69579c3 --- /dev/null +++ b/docs/equinix_metalv1_capacity_check-capacity-for-facility.md @@ -0,0 +1,35 @@ +## equinix metalv1 capacity check-capacity-for-facility + +Check capacity + +### Synopsis + +Validates if a deploy can be fulfilled. Deprecated + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 capacity check-capacity-for-facility [flags] +``` + +### Options + +``` + --capacity-input-additional-properties string capacity-input-additional-properties (JSON) + --capacity-input-servers string capacity-input-servers (JSON array) + -h, --help help for check-capacity-for-facility + --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 capacity](equinix_metalv1_capacity.md) - Manage capacity resources + diff --git a/docs/equinix_metalv1_capacity_check-capacity-for-metro.md b/docs/equinix_metalv1_capacity_check-capacity-for-metro.md new file mode 100644 index 0000000..8bcafdf --- /dev/null +++ b/docs/equinix_metalv1_capacity_check-capacity-for-metro.md @@ -0,0 +1,35 @@ +## equinix metalv1 capacity check-capacity-for-metro + +Check capacity for a metro + +### Synopsis + +Validates if a deploy can be fulfilled in a metro. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 capacity check-capacity-for-metro [flags] +``` + +### Options + +``` + --capacity-input-additional-properties string capacity-input-additional-properties (JSON) + --capacity-input-servers string capacity-input-servers (JSON array) + -h, --help help for check-capacity-for-metro + --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 capacity](equinix_metalv1_capacity.md) - Manage capacity resources + diff --git a/docs/equinix_metalv1_capacity_find-capacity-for-facility.md b/docs/equinix_metalv1_capacity_find-capacity-for-facility.md new file mode 100644 index 0000000..f7f1303 --- /dev/null +++ b/docs/equinix_metalv1_capacity_find-capacity-for-facility.md @@ -0,0 +1,33 @@ +## equinix metalv1 capacity find-capacity-for-facility + +View capacity + +### Synopsis + +Returns a list of facilities and plans with their current capacity. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 capacity find-capacity-for-facility [flags] +``` + +### Options + +``` + -h, --help help for find-capacity-for-facility + --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 capacity](equinix_metalv1_capacity.md) - Manage capacity resources + diff --git a/docs/equinix_metalv1_capacity_find-capacity-for-metro.md b/docs/equinix_metalv1_capacity_find-capacity-for-metro.md new file mode 100644 index 0000000..95d6f98 --- /dev/null +++ b/docs/equinix_metalv1_capacity_find-capacity-for-metro.md @@ -0,0 +1,33 @@ +## equinix metalv1 capacity find-capacity-for-metro + +View capacity for metros + +### Synopsis + +Returns a list of metros and plans with their current capacity. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 capacity find-capacity-for-metro [flags] +``` + +### Options + +``` + -h, --help help for find-capacity-for-metro + --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 capacity](equinix_metalv1_capacity.md) - Manage capacity resources + diff --git a/docs/equinix_metalv1_capacity_find-organization-capacity-per-facility.md b/docs/equinix_metalv1_capacity_find-organization-capacity-per-facility.md new file mode 100644 index 0000000..53cc4e4 --- /dev/null +++ b/docs/equinix_metalv1_capacity_find-organization-capacity-per-facility.md @@ -0,0 +1,34 @@ +## equinix metalv1 capacity find-organization-capacity-per-facility + +View available hardware plans per Facility for given organization + +### Synopsis + +Returns a list of facilities and plans with their current capacity. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 capacity find-organization-capacity-per-facility [flags] +``` + +### Options + +``` + -h, --help help for find-organization-capacity-per-facility + --id string Organization 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 capacity](equinix_metalv1_capacity.md) - Manage capacity resources + diff --git a/docs/equinix_metalv1_capacity_find-organization-capacity-per-metro.md b/docs/equinix_metalv1_capacity_find-organization-capacity-per-metro.md new file mode 100644 index 0000000..d6c5aa8 --- /dev/null +++ b/docs/equinix_metalv1_capacity_find-organization-capacity-per-metro.md @@ -0,0 +1,34 @@ +## equinix metalv1 capacity find-organization-capacity-per-metro + +View available hardware plans per Metro for given organization + +### Synopsis + +Returns a list of metros and plans with their current capacity. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 capacity find-organization-capacity-per-metro [flags] +``` + +### Options + +``` + -h, --help help for find-organization-capacity-per-metro + --id string Organization 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 capacity](equinix_metalv1_capacity.md) - Manage capacity resources + diff --git a/docs/equinix_metalv1_console-log-details.md b/docs/equinix_metalv1_console-log-details.md new file mode 100644 index 0000000..3af98ef --- /dev/null +++ b/docs/equinix_metalv1_console-log-details.md @@ -0,0 +1,27 @@ +## equinix metalv1 console-log-details + +Manage console-log-details resources + +### Synopsis + +Commands for managing console-log-details resources in the API + +### Options + +``` + -h, --help help for console-log-details +``` + +### 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 console-log-details capture-screenshot](equinix_metalv1_console-log-details_capture-screenshot.md) - Method for CaptureScreenshot + diff --git a/docs/equinix_metalv1_console-log-details_capture-screenshot.md b/docs/equinix_metalv1_console-log-details_capture-screenshot.md new file mode 100644 index 0000000..713b716 --- /dev/null +++ b/docs/equinix_metalv1_console-log-details_capture-screenshot.md @@ -0,0 +1,34 @@ +## equinix metalv1 console-log-details capture-screenshot + +Method for CaptureScreenshot + +### Synopsis + +Capture a screenshot from the device, if supported, via the BMC. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 console-log-details capture-screenshot [flags] +``` + +### Options + +``` + -h, --help help for capture-screenshot + --id string Device 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 console-log-details](equinix_metalv1_console-log-details.md) - Manage console-log-details resources + diff --git a/docs/equinix_metalv1_devices.md b/docs/equinix_metalv1_devices.md new file mode 100644 index 0000000..d243f17 --- /dev/null +++ b/docs/equinix_metalv1_devices.md @@ -0,0 +1,46 @@ +## equinix metalv1 devices + +Manage devices resources + +### Synopsis + +Commands for managing devices resources in the API + +### Options + +``` + -h, --help help for devices +``` + +### 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 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 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-instance-bandwidth](equinix_metalv1_devices_find-instance-bandwidth.md) - Retrieve an instance bandwidth +* [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 +* [equinix metalv1 devices get-bgp-neighbor-data](equinix_metalv1_devices_get-bgp-neighbor-data.md) - Retrieve BGP neighbor data for this device +* [equinix metalv1 devices get-device-firmware-sets](equinix_metalv1_devices_get-device-firmware-sets.md) - Get Device's associated Firmware Set +* [equinix metalv1 devices get-device-health-rollup](equinix_metalv1_devices_get-device-health-rollup.md) - Get Device's Health Status +* [equinix metalv1 devices perform-action](equinix_metalv1_devices_perform-action.md) - Perform an action +* [equinix metalv1 devices update-device](equinix_metalv1_devices_update-device.md) - Update the device + diff --git a/docs/equinix_metalv1_devices_create-bgp-session.md b/docs/equinix_metalv1_devices_create-bgp-session.md new file mode 100644 index 0000000..627161e --- /dev/null +++ b/docs/equinix_metalv1_devices_create-bgp-session.md @@ -0,0 +1,38 @@ +## equinix metalv1 devices create-bgp-session + +Create a BGP session + +### Synopsis + +Creates a BGP session. + +Use --request flag to provide optional JSON payload fields. + +``` +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 +``` + +### 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-device.md b/docs/equinix_metalv1_devices_create-device.md new file mode 100644 index 0000000..1b6c145 --- /dev/null +++ b/docs/equinix_metalv1_devices_create-device.md @@ -0,0 +1,91 @@ +## equinix metalv1 devices create-device + +Create a device + +### Synopsis + +Creates a new device and provisions it in the specified location. Device type-specific options are accepted. For example, `baremetal` devices accept `operating_system`, `hostname`, and `plan`. These parameters may not be accepted for other device types. The default device type is `baremetal`. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices create-device [flags] +``` + +### Options + +``` + --create-device-request-device-create-in-facility-input-additional-properties string create-device-request-device-create-in-facility-input-additional-properties (JSON) + --create-device-request-device-create-in-facility-input-always_pxe custom_ipxe When true, devices with a custom_ipxe OS will always boot to iPXE. The default setting of false ensures that iPXE will be used on only the first boot. + --create-device-request-device-create-in-facility-input-billing_cycle string create-device-request-device-create-in-facility-input-billing_cycle + --create-device-request-device-create-in-facility-input-customdata string Customdata is an arbitrary JSON value that can be accessed via the metadata service. (JSON) + --create-device-request-device-create-in-facility-input-description string Any description of the device or how it will be used. This may be used to inform other API consumers with project access. + --create-device-request-device-create-in-facility-input-facility { \"facility\": \"f1\" } The datacenter where the device should be created. Either metro or facility must be provided. The API will accept either a single facility { \"facility\": \"f1\" }, or it can be instructed to create the device in the best available datacenter `{ \"facility\": \"any\" }`. Additionally it is possible to set a prioritized location selection. For example `{ \"facility\": [\"f3\", \"f2\", \"any\"] }` can be used to prioritize `f3` and then `f2` before accepting `any` facility. If none of the facilities provided have availability for the requested device the request will fail. + Deprecated (JSON array) + --create-device-request-device-create-in-facility-input-features required The features attribute allows you to optionally specify what features your server should have. In the API shorthand syntax, all features listed are required: ``` { \"features\": [\"tpm\"] } ``` Alternatively, if you do not require a certain feature, but would prefer to be assigned a server with that feature if there are any available, you may specify that feature with a `preferred` value. The request will not fail if we have no servers with that feature in our inventory. The API offers an alternative syntax for mixing preferred and required features: ``` { \"features\": { \"tpm\": \"required\", \"raid\": \"preferred\" } } ``` The request will only fail if there are no available servers matching the required `tpm` criteria. (JSON array) + --create-device-request-device-create-in-facility-input-hardware_reservation_id next-available The Hardware Reservation UUID to provision. Alternatively, next-available can be specified to select from any of the available hardware reservations. An error will be returned if the requested reservation option is not available. See [Reserved Hardware](https://deploy.equinix.com/developers/docs/metal/deploy/reserved/) for more details. + --create-device-request-device-create-in-facility-input-hostname string The hostname to use within the operating system. The same hostname may be used on multiple devices within a project. + --create-device-request-device-create-in-facility-input-ip_addresses ip_addresses attribute will allow you to specify the addresses you want created with your device. The default value configures public IPv4, public IPv6, and private IPv4. Private IPv4 address is required. When specifying The ip_addresses attribute will allow you to specify the addresses you want created with your device. The default value configures public IPv4, public IPv6, and private IPv4. Private IPv4 address is required. When specifying ip_addresses`, one of the array items must enable private IPv4. Some operating systems require public IPv4 address. In those cases you will receive an error message if public IPv4 is not enabled. For example, to only configure your server with a private IPv4 address, you can send `{ \"ip_addresses\": [{ \"address_family\": 4, \"public\": false }] }`. It is possible to request a subnet size larger than a `/30` by assigning addresses using the UUID(s) of ip_reservations in your project. For example, `{ \"ip_addresses\": [..., {\"address_family\": 4, \"public\": true, \"ip_reservations\": [\"uuid1\", \"uuid2\"]}] }` To access a server without public IPs, you can use our Out-of-Band console access (SOS) or proxy through another server in the project with public IPs enabled. (JSON array) + --create-device-request-device-create-in-facility-input-ipxe_script_url string When set, the device will chainload an iPXE Script at boot fetched from the supplied URL. See [Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/) for more details. + --create-device-request-device-create-in-facility-input-locked Whether the device should be locked, preventing accidental deletion. + --create-device-request-device-create-in-facility-input-network_frozen If true, this instance can not be converted to a different network type. + --create-device-request-device-create-in-facility-input-no_ssh_keys Overrides default behaviour of attaching all of the organization members ssh keys and project ssh keys to device if no specific keys specified + --create-device-request-device-create-in-facility-input-operating_system string The slug of the operating system to provision. Check the Equinix Metal operating system documentation for rules that may be imposed per operating system, including restrictions on IP address options and device plans. + --create-device-request-device-create-in-facility-input-plan string The slug of the device plan to provision. + --create-device-request-device-create-in-facility-input-private_ipv4_subnet_size int Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device. + --create-device-request-device-create-in-facility-input-project_ssh_keys user_ssh_keys A list of UUIDs identifying the device parent project that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. If no SSH keys are specified (user_ssh_keys, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added. (JSON array) + --create-device-request-device-create-in-facility-input-public_ipv4_subnet_size int Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device. Your project must have addresses available for a non-default request. + --create-device-request-device-create-in-facility-input-spot_instance termination_time Create a spot instance. Spot instances are created with a maximum bid price. If the bid price is not met, the spot instance will be terminated as indicated by the termination_time field. + --create-device-request-device-create-in-facility-input-spot_price_max float The maximum amount to bid for a spot instance. + --create-device-request-device-create-in-facility-input-ssh_keys project_ssh_keys A list of new or existing project ssh_keys that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. These keys are added in addition to any keys defined by project_ssh_keys and `user_ssh_keys`. (JSON array) + --create-device-request-device-create-in-facility-input-storage string create-device-request-device-create-in-facility-input-storage (JSON) + --create-device-request-device-create-in-facility-input-tags string create-device-request-device-create-in-facility-input-tags (JSON array) + --create-device-request-device-create-in-facility-input-termination_time string create-device-request-device-create-in-facility-input-termination_time (JSON) + --create-device-request-device-create-in-facility-input-user_ssh_keys user_ssh_keys A list of UUIDs identifying the users that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. The users must be members of the project or organization. If no SSH keys are specified (user_ssh_keys, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added. (JSON array) + --create-device-request-device-create-in-facility-input-userdata string The userdata presented in the metadata service for this device. Userdata is fetched and interpreted by the operating system installed on the device. Acceptable formats are determined by the operating system, with the exception of a special iPXE enabling syntax which is handled before the operating system starts. See [Server User Data](https://deploy.equinix.com/developers/docs/metal/server-metadata/user-data/) and [Provisioning with Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/#provisioning-with-custom-ipxe) for more details. + --create-device-request-device-create-in-metro-input-additional-properties string create-device-request-device-create-in-metro-input-additional-properties (JSON) + --create-device-request-device-create-in-metro-input-always_pxe custom_ipxe When true, devices with a custom_ipxe OS will always boot to iPXE. The default setting of false ensures that iPXE will be used on only the first boot. + --create-device-request-device-create-in-metro-input-billing_cycle string create-device-request-device-create-in-metro-input-billing_cycle + --create-device-request-device-create-in-metro-input-customdata string Customdata is an arbitrary JSON value that can be accessed via the metadata service. (JSON) + --create-device-request-device-create-in-metro-input-description string Any description of the device or how it will be used. This may be used to inform other API consumers with project access. + --create-device-request-device-create-in-metro-input-features required The features attribute allows you to optionally specify what features your server should have. In the API shorthand syntax, all features listed are required: ``` { \"features\": [\"tpm\"] } ``` Alternatively, if you do not require a certain feature, but would prefer to be assigned a server with that feature if there are any available, you may specify that feature with a `preferred` value. The request will not fail if we have no servers with that feature in our inventory. The API offers an alternative syntax for mixing preferred and required features: ``` { \"features\": { \"tpm\": \"required\", \"raid\": \"preferred\" } } ``` The request will only fail if there are no available servers matching the required `tpm` criteria. (JSON array) + --create-device-request-device-create-in-metro-input-hardware_reservation_id next-available The Hardware Reservation UUID to provision. Alternatively, next-available can be specified to select from any of the available hardware reservations. An error will be returned if the requested reservation option is not available. See [Reserved Hardware](https://deploy.equinix.com/developers/docs/metal/deploy/reserved/) for more details. + --create-device-request-device-create-in-metro-input-hostname string The hostname to use within the operating system. The same hostname may be used on multiple devices within a project. + --create-device-request-device-create-in-metro-input-ip_addresses ip_addresses attribute will allow you to specify the addresses you want created with your device. The default value configures public IPv4, public IPv6, and private IPv4. Private IPv4 address is required. When specifying The ip_addresses attribute will allow you to specify the addresses you want created with your device. The default value configures public IPv4, public IPv6, and private IPv4. Private IPv4 address is required. When specifying ip_addresses`, one of the array items must enable private IPv4. Some operating systems require public IPv4 address. In those cases you will receive an error message if public IPv4 is not enabled. For example, to only configure your server with a private IPv4 address, you can send `{ \"ip_addresses\": [{ \"address_family\": 4, \"public\": false }] }`. It is possible to request a subnet size larger than a `/30` by assigning addresses using the UUID(s) of ip_reservations in your project. For example, `{ \"ip_addresses\": [..., {\"address_family\": 4, \"public\": true, \"ip_reservations\": [\"uuid1\", \"uuid2\"]}] }` To access a server without public IPs, you can use our Out-of-Band console access (SOS) or proxy through another server in the project with public IPs enabled. (JSON array) + --create-device-request-device-create-in-metro-input-ipxe_script_url string When set, the device will chainload an iPXE Script at boot fetched from the supplied URL. See [Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/) for more details. + --create-device-request-device-create-in-metro-input-locked Whether the device should be locked, preventing accidental deletion. + --create-device-request-device-create-in-metro-input-metro { \"metro\": \"any\" } Metro code or ID of where the device should be provisioned in, or it can be instructed to create the device in the best available metro with { \"metro\": \"any\" }. The special metro value of any means anywhere, any metro. When any is chosen in the request, the metro location is picked per our scheduling algorithms that favor the following factors: hardware reservation location (if requesting reserved hardware), ip reservations, spot instances, etc. The any keyword *does not* optimize for cost, this means that usage costs (instance, transfer, other features dependent on location) will vary. Please check metro value in response to see where the device was created. Either metro or facility must be provided. + --create-device-request-device-create-in-metro-input-network_frozen If true, this instance can not be converted to a different network type. + --create-device-request-device-create-in-metro-input-no_ssh_keys Overrides default behaviour of attaching all of the organization members ssh keys and project ssh keys to device if no specific keys specified + --create-device-request-device-create-in-metro-input-operating_system string The slug of the operating system to provision. Check the Equinix Metal operating system documentation for rules that may be imposed per operating system, including restrictions on IP address options and device plans. + --create-device-request-device-create-in-metro-input-plan string The slug of the device plan to provision. + --create-device-request-device-create-in-metro-input-private_ipv4_subnet_size int Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device. + --create-device-request-device-create-in-metro-input-project_ssh_keys user_ssh_keys A list of UUIDs identifying the device parent project that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. If no SSH keys are specified (user_ssh_keys, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added. (JSON array) + --create-device-request-device-create-in-metro-input-public_ipv4_subnet_size int Deprecated. Use ip_addresses. Subnet range for addresses allocated to this device. Your project must have addresses available for a non-default request. + --create-device-request-device-create-in-metro-input-spot_instance termination_time Create a spot instance. Spot instances are created with a maximum bid price. If the bid price is not met, the spot instance will be terminated as indicated by the termination_time field. + --create-device-request-device-create-in-metro-input-spot_price_max float The maximum amount to bid for a spot instance. + --create-device-request-device-create-in-metro-input-ssh_keys project_ssh_keys A list of new or existing project ssh_keys that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. These keys are added in addition to any keys defined by project_ssh_keys and `user_ssh_keys`. (JSON array) + --create-device-request-device-create-in-metro-input-storage string create-device-request-device-create-in-metro-input-storage (JSON) + --create-device-request-device-create-in-metro-input-tags string create-device-request-device-create-in-metro-input-tags (JSON array) + --create-device-request-device-create-in-metro-input-termination_time string create-device-request-device-create-in-metro-input-termination_time (JSON) + --create-device-request-device-create-in-metro-input-user_ssh_keys user_ssh_keys A list of UUIDs identifying the users that should be authorized to access this device (typically via /root/.ssh/authorized_keys). These keys will also appear in the device metadata. The users must be members of the project or organization. If no SSH keys are specified (user_ssh_keys, `project_ssh_keys`, and `ssh_keys` are all empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. This behaviour can be changed with 'no_ssh_keys' option to omit any SSH key being added. (JSON array) + --create-device-request-device-create-in-metro-input-userdata string The userdata presented in the metadata service for this device. Userdata is fetched and interpreted by the operating system installed on the device. Acceptable formats are determined by the operating system, with the exception of a special iPXE enabling syntax which is handled before the operating system starts. See [Server User Data](https://deploy.equinix.com/developers/docs/metal/server-metadata/user-data/) and [Provisioning with Custom iPXE](https://deploy.equinix.com/developers/docs/metal/operating-systems/custom-ipxe/#provisioning-with-custom-ipxe) for more details. + --exclude string exclude field (JSON or string) + -h, --help help for create-device + --id string Project 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-i-p-assignment.md b/docs/equinix_metalv1_devices_create-i-p-assignment.md new file mode 100644 index 0000000..08c3108 --- /dev/null +++ b/docs/equinix_metalv1_devices_create-i-p-assignment.md @@ -0,0 +1,39 @@ +## 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_delete-device.md b/docs/equinix_metalv1_devices_delete-device.md new file mode 100644 index 0000000..cc699f7 --- /dev/null +++ b/docs/equinix_metalv1_devices_delete-device.md @@ -0,0 +1,35 @@ +## equinix metalv1 devices delete-device + +Delete the device + +### Synopsis + +Deletes a device and deprovisions it in our datacenter. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices delete-device [flags] +``` + +### Options + +``` + --force-delete force-delete field + -h, --help help for delete-device + --id string Device 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 devices](equinix_metalv1_devices.md) - Manage devices resources + diff --git a/docs/equinix_metalv1_devices_find-bgp-sessions.md b/docs/equinix_metalv1_devices_find-bgp-sessions.md new file mode 100644 index 0000000..a64b2ff --- /dev/null +++ b/docs/equinix_metalv1_devices_find-bgp-sessions.md @@ -0,0 +1,35 @@ +## equinix metalv1 devices find-bgp-sessions + +Retrieve all BGP sessions + +### Synopsis + +Provides a listing of available BGP sessions for the device. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices find-bgp-sessions [flags] +``` + +### Options + +``` + -h, --help help for find-bgp-sessions + --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_find-device-by-id.md b/docs/equinix_metalv1_devices_find-device-by-id.md new file mode 100644 index 0000000..a2260e4 --- /dev/null +++ b/docs/equinix_metalv1_devices_find-device-by-id.md @@ -0,0 +1,36 @@ +## equinix metalv1 devices find-device-by-id + +Retrieve a device + +### Synopsis + +Type-specific options (such as facility for baremetal devices) will be included as part of the main data structure. State value can be one of: active inactive queued or provisioning + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices find-device-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-device-by-id + --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_find-device-customdata.md b/docs/equinix_metalv1_devices_find-device-customdata.md new file mode 100644 index 0000000..e59b00e --- /dev/null +++ b/docs/equinix_metalv1_devices_find-device-customdata.md @@ -0,0 +1,34 @@ +## equinix metalv1 devices find-device-customdata + +Retrieve the custom metadata of an instance + +### Synopsis + +Provides the custom metadata stored for this instance in json format + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices find-device-customdata [flags] +``` + +### Options + +``` + -h, --help help for find-device-customdata + --id string Instance 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 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-i-d.md new file mode 100644 index 0000000..ffec732 --- /dev/null +++ b/docs/equinix_metalv1_devices_find-device-metadata-by-i-d.md @@ -0,0 +1,34 @@ +## equinix metalv1 devices find-device-metadata-by-i-d + +Retrieve metadata + +### Synopsis + +Retrieve device metadata + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices find-device-metadata-by-i-d [flags] +``` + +### Options + +``` + -h, --help help for find-device-metadata-by-i-d + --id string Device 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 devices](equinix_metalv1_devices.md) - Manage devices resources + diff --git a/docs/equinix_metalv1_devices_find-device-userdata-by-i-d.md b/docs/equinix_metalv1_devices_find-device-userdata-by-i-d.md new file mode 100644 index 0000000..48c1281 --- /dev/null +++ b/docs/equinix_metalv1_devices_find-device-userdata-by-i-d.md @@ -0,0 +1,34 @@ +## equinix metalv1 devices find-device-userdata-by-i-d + +Retrieve userdata + +### Synopsis + +Retrieve device userdata + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices find-device-userdata-by-i-d [flags] +``` + +### Options + +``` + -h, --help help for find-device-userdata-by-i-d + --id string Device 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 devices](equinix_metalv1_devices.md) - Manage devices resources + diff --git a/docs/equinix_metalv1_devices_find-i-p-assignment-customdata.md b/docs/equinix_metalv1_devices_find-i-p-assignment-customdata.md new file mode 100644 index 0000000..b03467f --- /dev/null +++ b/docs/equinix_metalv1_devices_find-i-p-assignment-customdata.md @@ -0,0 +1,35 @@ +## equinix metalv1 devices find-i-p-assignment-customdata + +Retrieve the custom metadata of an IP Assignment + +### Synopsis + +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] +``` + +### Options + +``` + -h, --help help for find-i-p-assignment-customdata + --id string Ip Assignment UUID (required) + --instance-id string Instance 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 devices](equinix_metalv1_devices.md) - Manage devices resources + diff --git a/docs/equinix_metalv1_devices_find-i-p-assignments.md b/docs/equinix_metalv1_devices_find-i-p-assignments.md new file mode 100644 index 0000000..3286559 --- /dev/null +++ b/docs/equinix_metalv1_devices_find-i-p-assignments.md @@ -0,0 +1,36 @@ +## equinix metalv1 devices find-i-p-assignments + +Retrieve all ip assignments + +### Synopsis + +Returns all ip assignments for a device. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices find-i-p-assignments [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-i-p-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 +``` + +### 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-instance-bandwidth.md b/docs/equinix_metalv1_devices_find-instance-bandwidth.md new file mode 100644 index 0000000..952e9ea --- /dev/null +++ b/docs/equinix_metalv1_devices_find-instance-bandwidth.md @@ -0,0 +1,36 @@ +## equinix metalv1 devices find-instance-bandwidth + +Retrieve an instance bandwidth + +### Synopsis + +Retrieve an instance bandwidth for a given period of time. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices find-instance-bandwidth [flags] +``` + +### Options + +``` + --from string from field + -h, --help help for find-instance-bandwidth + --id string Device UUID (required) + --request string JSON payload for additional optional fields not exposed as flags + --until string until 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 devices](equinix_metalv1_devices.md) - Manage devices resources + diff --git a/docs/equinix_metalv1_devices_find-organization-devices.md b/docs/equinix_metalv1_devices_find-organization-devices.md new file mode 100644 index 0000000..ee8c5d8 --- /dev/null +++ b/docs/equinix_metalv1_devices_find-organization-devices.md @@ -0,0 +1,47 @@ +## equinix metalv1 devices find-organization-devices + +Retrieve all devices of an organization + +### Synopsis + +Provides a collection of devices for a given organization. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices find-organization-devices [flags] +``` + +### Options + +``` + --categories string categories field (JSON or string) + --exclude string exclude field (JSON or string) + --facility string facility field + --has-termination-time has-termination-time field + -h, --help help for find-organization-devices + --hostname string hostname field + --id string Organization UUID (required) + --include string include field (JSON or string) + --mac-address string mac-address field + --page int page field + --per-page int per-page field + --request string JSON payload for additional optional fields not exposed as flags + --reserved reserved field + --search string search field + --tag string tag field + --type_ string type_ 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 devices](equinix_metalv1_devices.md) - Manage devices resources + diff --git a/docs/equinix_metalv1_devices_find-project-devices.md b/docs/equinix_metalv1_devices_find-project-devices.md new file mode 100644 index 0000000..06df6da --- /dev/null +++ b/docs/equinix_metalv1_devices_find-project-devices.md @@ -0,0 +1,48 @@ +## equinix metalv1 devices find-project-devices + +Retrieve all devices of a project + +### Synopsis + +Provides a collection of devices for a given project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices find-project-devices [flags] +``` + +### Options + +``` + --categories string categories field (JSON or string) + --exclude string exclude field (JSON or string) + --facility string facility field + --has-termination-time has-termination-time field + -h, --help help for find-project-devices + --hostname string hostname field + --id string Project UUID (required) + --include string include field (JSON or string) + --mac-address string mac-address field + --metro string metro field + --page int page field + --per-page int per-page field + --request string JSON payload for additional optional fields not exposed as flags + --reserved reserved field + --search string search field + --tag string tag field + --type_ string type_ 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 devices](equinix_metalv1_devices.md) - Manage devices resources + diff --git a/docs/equinix_metalv1_devices_find-traffic.md b/docs/equinix_metalv1_devices_find-traffic.md new file mode 100644 index 0000000..8c8b184 --- /dev/null +++ b/docs/equinix_metalv1_devices_find-traffic.md @@ -0,0 +1,38 @@ +## equinix metalv1 devices find-traffic + +Retrieve device traffic + +### Synopsis + +Returns the total amount of inbound or outbound traffic for a specific device. The default time period is 1 hour. Please note the results capture all network traffic for the server, but not all traffic may come from or be destined to the Internet and may be non-billable. Only Internet bound traffic is charged. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices find-traffic [flags] +``` + +### Options + +``` + --bucket string bucket field + --direction string direction field + -h, --help help for find-traffic + --id string Device UUID (required) + --interval string interval field + --request string JSON payload for additional optional fields not exposed as flags + --timeframe-additional-properties string timeframe-additional-properties (JSON) +``` + +### 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_get-bgp-neighbor-data.md b/docs/equinix_metalv1_devices_get-bgp-neighbor-data.md new file mode 100644 index 0000000..f9f3154 --- /dev/null +++ b/docs/equinix_metalv1_devices_get-bgp-neighbor-data.md @@ -0,0 +1,35 @@ +## equinix metalv1 devices get-bgp-neighbor-data + +Retrieve BGP neighbor data for this device + +### Synopsis + +Provides a summary of the BGP neighbor data associated to the BGP sessions for this device. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices get-bgp-neighbor-data [flags] +``` + +### Options + +``` + -h, --help help for get-bgp-neighbor-data + --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_get-device-firmware-sets.md b/docs/equinix_metalv1_devices_get-device-firmware-sets.md new file mode 100644 index 0000000..61f23b5 --- /dev/null +++ b/docs/equinix_metalv1_devices_get-device-firmware-sets.md @@ -0,0 +1,34 @@ +## equinix metalv1 devices get-device-firmware-sets + +Get Device's associated Firmware Set + +### Synopsis + +Returns the firmware set associated with the device. If a custom firmware set is associated with the device, then it is returned. Otherwise, if a default firmware set is available it is returned. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices get-device-firmware-sets [flags] +``` + +### Options + +``` + -h, --help help for get-device-firmware-sets + --id string Device 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 devices](equinix_metalv1_devices.md) - Manage devices resources + diff --git a/docs/equinix_metalv1_devices_get-device-health-rollup.md b/docs/equinix_metalv1_devices_get-device-health-rollup.md new file mode 100644 index 0000000..f0d0a93 --- /dev/null +++ b/docs/equinix_metalv1_devices_get-device-health-rollup.md @@ -0,0 +1,34 @@ +## equinix metalv1 devices get-device-health-rollup + +Get Device's Health Status + +### Synopsis + +Returns the health rollup status of the device. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices get-device-health-rollup [flags] +``` + +### Options + +``` + -h, --help help for get-device-health-rollup + --id string Device 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 devices](equinix_metalv1_devices.md) - Manage devices resources + diff --git a/docs/equinix_metalv1_devices_perform-action.md b/docs/equinix_metalv1_devices_perform-action.md new file mode 100644 index 0000000..e9cb985 --- /dev/null +++ b/docs/equinix_metalv1_devices_perform-action.md @@ -0,0 +1,41 @@ +## equinix metalv1 devices perform-action + +Perform an action + +### Synopsis + +Performs an action for the given device. Possible actions include: power_on, power_off, reboot, reinstall, and rescue (reboot the device into rescue OS.) + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices perform-action [flags] +``` + +### Options + +``` + --device-action-input-additional-properties string device-action-input-additional-properties (JSON) + --device-action-input-deprovision_fast reinstall When type is reinstall, enabling fast deprovisioning will bypass full disk wiping. + --device-action-input-force_delete May be required to perform actions under certain conditions + --device-action-input-ipxe_script_url reinstall When type is reinstall, use this `ipxe_script_url` (`operating_system` must be `custom_ipxe`, defaults to the current `ipxe_script_url`) + --device-action-input-operating_system reinstall When type is reinstall, use this `operating_system` (defaults to the current `operating system`) + --device-action-input-preserve_data reinstall When type is reinstall, preserve the existing data on all disks except the operating-system disk. + --device-action-input-type string device-action-input-type + -h, --help help for perform-action + --id string Device 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 devices](equinix_metalv1_devices.md) - Manage devices resources + diff --git a/docs/equinix_metalv1_devices_update-device.md b/docs/equinix_metalv1_devices_update-device.md new file mode 100644 index 0000000..4eeaca5 --- /dev/null +++ b/docs/equinix_metalv1_devices_update-device.md @@ -0,0 +1,49 @@ +## equinix metalv1 devices update-device + +Update the device + +### Synopsis + +Updates the device. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 devices update-device [flags] +``` + +### Options + +``` + --device-update-input-additional-properties string device-update-input-additional-properties (JSON) + --device-update-input-always_pxe device-update-input-always_pxe + --device-update-input-billing_cycle string device-update-input-billing_cycle + --device-update-input-customdata string device-update-input-customdata (JSON) + --device-update-input-description string device-update-input-description + --device-update-input-firmware_set_id string device-update-input-firmware_set_id + --device-update-input-hostname string device-update-input-hostname + --device-update-input-ipxe_script_url string device-update-input-ipxe_script_url + --device-update-input-locked Whether the device should be locked, preventing accidental deletion. + --device-update-input-network_frozen If true, this instance can not be converted to a different network type. + --device-update-input-spot_instance Can be set to false to convert a spot-market instance to on-demand. + --device-update-input-tags string device-update-input-tags (JSON array) + --device-update-input-userdata string device-update-input-userdata + --exclude string exclude field (JSON or string) + -h, --help help for update-device + --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_emails.md b/docs/equinix_metalv1_emails.md new file mode 100644 index 0000000..7a2d31c --- /dev/null +++ b/docs/equinix_metalv1_emails.md @@ -0,0 +1,30 @@ +## equinix metalv1 emails + +Manage emails resources + +### Synopsis + +Commands for managing emails resources in the API + +### Options + +``` + -h, --help help for emails +``` + +### 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 emails create-email](equinix_metalv1_emails_create-email.md) - Create an email +* [equinix metalv1 emails delete-email](equinix_metalv1_emails_delete-email.md) - Delete the email +* [equinix metalv1 emails find-email-by-id](equinix_metalv1_emails_find-email-by-id.md) - Retrieve an email +* [equinix metalv1 emails update-email](equinix_metalv1_emails_update-email.md) - Update the email + diff --git a/docs/equinix_metalv1_emails_create-email.md b/docs/equinix_metalv1_emails_create-email.md new file mode 100644 index 0000000..1437909 --- /dev/null +++ b/docs/equinix_metalv1_emails_create-email.md @@ -0,0 +1,35 @@ +## equinix metalv1 emails create-email + +Create an email + +### Synopsis + +Add a new email address to the current user. Deprecated + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 emails create-email [flags] +``` + +### Options + +``` + --create-email-input-additional-properties string create-email-input-additional-properties (JSON) + --create-email-input-address string create-email-input-address + -h, --help help for create-email + --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 emails](equinix_metalv1_emails.md) - Manage emails resources + diff --git a/docs/equinix_metalv1_emails_delete-email.md b/docs/equinix_metalv1_emails_delete-email.md new file mode 100644 index 0000000..ef5a275 --- /dev/null +++ b/docs/equinix_metalv1_emails_delete-email.md @@ -0,0 +1,34 @@ +## equinix metalv1 emails delete-email + +Delete the email + +### Synopsis + +Deletes the email. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 emails delete-email [flags] +``` + +### Options + +``` + -h, --help help for delete-email + --id string Email 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 emails](equinix_metalv1_emails.md) - Manage emails resources + diff --git a/docs/equinix_metalv1_emails_find-email-by-id.md b/docs/equinix_metalv1_emails_find-email-by-id.md new file mode 100644 index 0000000..1a574cf --- /dev/null +++ b/docs/equinix_metalv1_emails_find-email-by-id.md @@ -0,0 +1,34 @@ +## equinix metalv1 emails find-email-by-id + +Retrieve an email + +### Synopsis + +Provides one of the user’s emails. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 emails find-email-by-id [flags] +``` + +### Options + +``` + -h, --help help for find-email-by-id + --id string Email 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 emails](equinix_metalv1_emails.md) - Manage emails resources + diff --git a/docs/equinix_metalv1_emails_update-email.md b/docs/equinix_metalv1_emails_update-email.md new file mode 100644 index 0000000..9cdeda3 --- /dev/null +++ b/docs/equinix_metalv1_emails_update-email.md @@ -0,0 +1,36 @@ +## equinix metalv1 emails update-email + +Update the email + +### Synopsis + +Updates the email. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 emails update-email [flags] +``` + +### Options + +``` + -h, --help help for update-email + --id string Email UUID (required) + --request string JSON payload for additional optional fields not exposed as flags + --update-email-input-additional-properties string update-email-input-additional-properties (JSON) + --update-email-input-default update-email-input-default +``` + +### 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 emails](equinix_metalv1_emails.md) - Manage emails resources + diff --git a/docs/equinix_metalv1_events.md b/docs/equinix_metalv1_events.md new file mode 100644 index 0000000..2840824 --- /dev/null +++ b/docs/equinix_metalv1_events.md @@ -0,0 +1,35 @@ +## equinix metalv1 events + +Manage events resources + +### Synopsis + +Commands for managing events resources in the API + +### Options + +``` + -h, --help help for events +``` + +### 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 events find-device-events](equinix_metalv1_events_find-device-events.md) - Retrieve device's events +* [equinix metalv1 events find-event-by-id](equinix_metalv1_events_find-event-by-id.md) - Retrieve an event +* [equinix metalv1 events find-events](equinix_metalv1_events_find-events.md) - Retrieve current user's events +* [equinix metalv1 events find-interconnection-events](equinix_metalv1_events_find-interconnection-events.md) - Retrieve interconnection events +* [equinix metalv1 events find-interconnection-port-events](equinix_metalv1_events_find-interconnection-port-events.md) - Retrieve interconnection port events +* [equinix metalv1 events find-organization-events](equinix_metalv1_events_find-organization-events.md) - Retrieve organization's events +* [equinix metalv1 events find-project-events](equinix_metalv1_events_find-project-events.md) - Retrieve project's events +* [equinix metalv1 events find-virtual-circuit-events](equinix_metalv1_events_find-virtual-circuit-events.md) - Retrieve virtual circuit events +* [equinix metalv1 events find-vrf-route-events](equinix_metalv1_events_find-vrf-route-events.md) - Retrieve VRF route events + diff --git a/docs/equinix_metalv1_events_find-device-events.md b/docs/equinix_metalv1_events_find-device-events.md new file mode 100644 index 0000000..ed37327 --- /dev/null +++ b/docs/equinix_metalv1_events_find-device-events.md @@ -0,0 +1,38 @@ +## equinix metalv1 events find-device-events + +Retrieve device's events + +### Synopsis + +Returns a list of events pertaining to a specific device + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 events find-device-events [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-device-events + --id string Device UUID (required) + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 events](equinix_metalv1_events.md) - Manage events resources + diff --git a/docs/equinix_metalv1_events_find-event-by-id.md b/docs/equinix_metalv1_events_find-event-by-id.md new file mode 100644 index 0000000..11a0427 --- /dev/null +++ b/docs/equinix_metalv1_events_find-event-by-id.md @@ -0,0 +1,36 @@ +## equinix metalv1 events find-event-by-id + +Retrieve an event + +### Synopsis + +Returns a single event if the user has access + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 events find-event-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-event-by-id + --id string Event 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 events](equinix_metalv1_events.md) - Manage events resources + diff --git a/docs/equinix_metalv1_events_find-events.md b/docs/equinix_metalv1_events_find-events.md new file mode 100644 index 0000000..96eac08 --- /dev/null +++ b/docs/equinix_metalv1_events_find-events.md @@ -0,0 +1,37 @@ +## equinix metalv1 events find-events + +Retrieve current user's events + +### Synopsis + +Returns a list of the current user’s events + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 events find-events [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-events + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 events](equinix_metalv1_events.md) - Manage events resources + diff --git a/docs/equinix_metalv1_events_find-interconnection-events.md b/docs/equinix_metalv1_events_find-interconnection-events.md new file mode 100644 index 0000000..7f2866f --- /dev/null +++ b/docs/equinix_metalv1_events_find-interconnection-events.md @@ -0,0 +1,38 @@ +## equinix metalv1 events find-interconnection-events + +Retrieve interconnection events + +### Synopsis + +Returns a list of the interconnection events + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 events find-interconnection-events [flags] +``` + +### Options + +``` + --connection-id string Interconnection UUID (required) + --exclude string exclude field (JSON or string) + -h, --help help for find-interconnection-events + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 events](equinix_metalv1_events.md) - Manage events resources + diff --git a/docs/equinix_metalv1_events_find-interconnection-port-events.md b/docs/equinix_metalv1_events_find-interconnection-port-events.md new file mode 100644 index 0000000..16e05f9 --- /dev/null +++ b/docs/equinix_metalv1_events_find-interconnection-port-events.md @@ -0,0 +1,39 @@ +## equinix metalv1 events find-interconnection-port-events + +Retrieve interconnection port events + +### Synopsis + +Returns a list of the interconnection port events + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 events find-interconnection-port-events [flags] +``` + +### Options + +``` + --connection-id string Interconnection UUID (required) + --exclude string exclude field (JSON or string) + -h, --help help for find-interconnection-port-events + --id string Interconnection Port UUID (required) + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 events](equinix_metalv1_events.md) - Manage events resources + diff --git a/docs/equinix_metalv1_events_find-organization-events.md b/docs/equinix_metalv1_events_find-organization-events.md new file mode 100644 index 0000000..048db5a --- /dev/null +++ b/docs/equinix_metalv1_events_find-organization-events.md @@ -0,0 +1,38 @@ +## equinix metalv1 events find-organization-events + +Retrieve organization's events + +### Synopsis + +Returns a list of events for a single organization + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 events find-organization-events [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-organization-events + --id string Organization UUID (required) + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 events](equinix_metalv1_events.md) - Manage events resources + diff --git a/docs/equinix_metalv1_events_find-project-events.md b/docs/equinix_metalv1_events_find-project-events.md new file mode 100644 index 0000000..d73524d --- /dev/null +++ b/docs/equinix_metalv1_events_find-project-events.md @@ -0,0 +1,38 @@ +## equinix metalv1 events find-project-events + +Retrieve project's events + +### Synopsis + +Returns a list of events for a single project + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 events find-project-events [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-project-events + --id string Project UUID (required) + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 events](equinix_metalv1_events.md) - Manage events resources + diff --git a/docs/equinix_metalv1_events_find-virtual-circuit-events.md b/docs/equinix_metalv1_events_find-virtual-circuit-events.md new file mode 100644 index 0000000..6622fe6 --- /dev/null +++ b/docs/equinix_metalv1_events_find-virtual-circuit-events.md @@ -0,0 +1,38 @@ +## equinix metalv1 events find-virtual-circuit-events + +Retrieve virtual circuit events + +### Synopsis + +Returns a list of the virtual circuit events + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 events find-virtual-circuit-events [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-virtual-circuit-events + --id string Virtual Circuit UUID (required) + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 events](equinix_metalv1_events.md) - Manage events resources + diff --git a/docs/equinix_metalv1_events_find-vrf-route-events.md b/docs/equinix_metalv1_events_find-vrf-route-events.md new file mode 100644 index 0000000..3bc1901 --- /dev/null +++ b/docs/equinix_metalv1_events_find-vrf-route-events.md @@ -0,0 +1,38 @@ +## equinix metalv1 events find-vrf-route-events + +Retrieve VRF route events + +### Synopsis + +Returns a list of the VRF route events + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 events find-vrf-route-events [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-vrf-route-events + --id string VRF Route UUID (required) + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 events](equinix_metalv1_events.md) - Manage events resources + diff --git a/docs/equinix_metalv1_facilities.md b/docs/equinix_metalv1_facilities.md new file mode 100644 index 0000000..81bc059 --- /dev/null +++ b/docs/equinix_metalv1_facilities.md @@ -0,0 +1,29 @@ +## equinix metalv1 facilities + +Manage facilities resources + +### Synopsis + +Commands for managing facilities resources in the API + +### Options + +``` + -h, --help help for facilities +``` + +### 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 facilities find-facilities](equinix_metalv1_facilities_find-facilities.md) - Retrieve all facilities +* [equinix metalv1 facilities find-facilities-by-organization](equinix_metalv1_facilities_find-facilities-by-organization.md) - Retrieve all facilities visible by the organization +* [equinix metalv1 facilities find-facilities-by-project](equinix_metalv1_facilities_find-facilities-by-project.md) - Retrieve all facilities visible by the project + diff --git a/docs/equinix_metalv1_facilities_find-facilities-by-organization.md b/docs/equinix_metalv1_facilities_find-facilities-by-organization.md new file mode 100644 index 0000000..b945c3d --- /dev/null +++ b/docs/equinix_metalv1_facilities_find-facilities-by-organization.md @@ -0,0 +1,36 @@ +## equinix metalv1 facilities find-facilities-by-organization + +Retrieve all facilities visible by the organization + +### Synopsis + +Returns a listing of available datacenters for the given organization Deprecated + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 facilities find-facilities-by-organization [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-facilities-by-organization + --id string Organization 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 facilities](equinix_metalv1_facilities.md) - Manage facilities resources + diff --git a/docs/equinix_metalv1_facilities_find-facilities-by-project.md b/docs/equinix_metalv1_facilities_find-facilities-by-project.md new file mode 100644 index 0000000..601c1c6 --- /dev/null +++ b/docs/equinix_metalv1_facilities_find-facilities-by-project.md @@ -0,0 +1,36 @@ +## equinix metalv1 facilities find-facilities-by-project + +Retrieve all facilities visible by the project + +### Synopsis + +Returns a listing of available datacenters for the given project Deprecated + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 facilities find-facilities-by-project [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-facilities-by-project + --id string Project 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 facilities](equinix_metalv1_facilities.md) - Manage facilities resources + diff --git a/docs/equinix_metalv1_facilities_find-facilities.md b/docs/equinix_metalv1_facilities_find-facilities.md new file mode 100644 index 0000000..3749c0e --- /dev/null +++ b/docs/equinix_metalv1_facilities_find-facilities.md @@ -0,0 +1,35 @@ +## equinix metalv1 facilities find-facilities + +Retrieve all facilities + +### Synopsis + +Provides a listing of available datacenters where you can provision Packet devices. Deprecated + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 facilities find-facilities [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-facilities + --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 facilities](equinix_metalv1_facilities.md) - Manage facilities resources + diff --git a/docs/equinix_metalv1_firmware-sets.md b/docs/equinix_metalv1_firmware-sets.md new file mode 100644 index 0000000..a6d2cc8 --- /dev/null +++ b/docs/equinix_metalv1_firmware-sets.md @@ -0,0 +1,28 @@ +## equinix metalv1 firmware-sets + +Manage firmware-sets resources + +### Synopsis + +Commands for managing firmware-sets resources in the API + +### Options + +``` + -h, --help help for firmware-sets +``` + +### 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 firmware-sets get-organization-firmware-sets](equinix_metalv1_firmware-sets_get-organization-firmware-sets.md) - Get Organization's Firmware Sets +* [equinix metalv1 firmware-sets get-project-firmware-sets](equinix_metalv1_firmware-sets_get-project-firmware-sets.md) - Get Project's Firmware Sets + diff --git a/docs/equinix_metalv1_firmware-sets_get-organization-firmware-sets.md b/docs/equinix_metalv1_firmware-sets_get-organization-firmware-sets.md new file mode 100644 index 0000000..c69a1d9 --- /dev/null +++ b/docs/equinix_metalv1_firmware-sets_get-organization-firmware-sets.md @@ -0,0 +1,36 @@ +## equinix metalv1 firmware-sets get-organization-firmware-sets + +Get Organization's Firmware Sets + +### Synopsis + +Returns all firmware sets associated with the organization. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 firmware-sets get-organization-firmware-sets [flags] +``` + +### Options + +``` + -h, --help help for get-organization-firmware-sets + --id string Organization UUID (required) + --page int page field + --per-page int per-page 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 firmware-sets](equinix_metalv1_firmware-sets.md) - Manage firmware-sets resources + diff --git a/docs/equinix_metalv1_firmware-sets_get-project-firmware-sets.md b/docs/equinix_metalv1_firmware-sets_get-project-firmware-sets.md new file mode 100644 index 0000000..2d5939a --- /dev/null +++ b/docs/equinix_metalv1_firmware-sets_get-project-firmware-sets.md @@ -0,0 +1,36 @@ +## equinix metalv1 firmware-sets get-project-firmware-sets + +Get Project's Firmware Sets + +### Synopsis + +Returns all firmware sets associated with the project or organization. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 firmware-sets get-project-firmware-sets [flags] +``` + +### Options + +``` + -h, --help help for get-project-firmware-sets + --id string Project UUID (required) + --page int page field + --per-page int per-page 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 firmware-sets](equinix_metalv1_firmware-sets.md) - Manage firmware-sets resources + diff --git a/docs/equinix_metalv1_hardware-reservations.md b/docs/equinix_metalv1_hardware-reservations.md new file mode 100644 index 0000000..2ccad92 --- /dev/null +++ b/docs/equinix_metalv1_hardware-reservations.md @@ -0,0 +1,30 @@ +## equinix metalv1 hardware-reservations + +Manage hardware-reservations resources + +### Synopsis + +Commands for managing hardware-reservations resources in the API + +### Options + +``` + -h, --help help for hardware-reservations +``` + +### 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 hardware-reservations activate-hardware-reservation](equinix_metalv1_hardware-reservations_activate-hardware-reservation.md) - Activate a spare hardware reservation +* [equinix metalv1 hardware-reservations find-hardware-reservation-by-id](equinix_metalv1_hardware-reservations_find-hardware-reservation-by-id.md) - Retrieve a hardware reservation +* [equinix metalv1 hardware-reservations find-project-hardware-reservations](equinix_metalv1_hardware-reservations_find-project-hardware-reservations.md) - Retrieve all hardware reservations for a given project +* [equinix metalv1 hardware-reservations move-hardware-reservation](equinix_metalv1_hardware-reservations_move-hardware-reservation.md) - Move a hardware reservation + diff --git a/docs/equinix_metalv1_hardware-reservations_activate-hardware-reservation.md b/docs/equinix_metalv1_hardware-reservations_activate-hardware-reservation.md new file mode 100644 index 0000000..b13eebe --- /dev/null +++ b/docs/equinix_metalv1_hardware-reservations_activate-hardware-reservation.md @@ -0,0 +1,38 @@ +## equinix metalv1 hardware-reservations activate-hardware-reservation + +Activate a spare hardware reservation + +### Synopsis + +Activate a spare hardware reservation + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 hardware-reservations activate-hardware-reservation [flags] +``` + +### Options + +``` + --activate-hardware-reservation-request-additional-properties string activate-hardware-reservation-request-additional-properties (JSON) + --activate-hardware-reservation-request-description string activate-hardware-reservation-request-description + --exclude string exclude field (JSON or string) + -h, --help help for activate-hardware-reservation + --id string Hardware Reservation 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 hardware-reservations](equinix_metalv1_hardware-reservations.md) - Manage hardware-reservations resources + diff --git a/docs/equinix_metalv1_hardware-reservations_find-hardware-reservation-by-id.md b/docs/equinix_metalv1_hardware-reservations_find-hardware-reservation-by-id.md new file mode 100644 index 0000000..a482409 --- /dev/null +++ b/docs/equinix_metalv1_hardware-reservations_find-hardware-reservation-by-id.md @@ -0,0 +1,36 @@ +## equinix metalv1 hardware-reservations find-hardware-reservation-by-id + +Retrieve a hardware reservation + +### Synopsis + +Returns a single hardware reservation + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 hardware-reservations find-hardware-reservation-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-hardware-reservation-by-id + --id string HardwareReservation 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 hardware-reservations](equinix_metalv1_hardware-reservations.md) - Manage hardware-reservations resources + diff --git a/docs/equinix_metalv1_hardware-reservations_find-project-hardware-reservations.md b/docs/equinix_metalv1_hardware-reservations_find-project-hardware-reservations.md new file mode 100644 index 0000000..b708b60 --- /dev/null +++ b/docs/equinix_metalv1_hardware-reservations_find-project-hardware-reservations.md @@ -0,0 +1,41 @@ +## equinix metalv1 hardware-reservations find-project-hardware-reservations + +Retrieve all hardware reservations for a given project + +### Synopsis + +Provides a collection of hardware reservations for a given project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 hardware-reservations find-project-hardware-reservations [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-project-hardware-reservations + --id string Project UUID (required) + --include string include field (JSON or string) + --page int page field + --per-page int per-page field + --provisionable string provisionable field + --query string query field + --request string JSON payload for additional optional fields not exposed as flags + --state string state 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 hardware-reservations](equinix_metalv1_hardware-reservations.md) - Manage hardware-reservations resources + diff --git a/docs/equinix_metalv1_hardware-reservations_move-hardware-reservation.md b/docs/equinix_metalv1_hardware-reservations_move-hardware-reservation.md new file mode 100644 index 0000000..306c9bc --- /dev/null +++ b/docs/equinix_metalv1_hardware-reservations_move-hardware-reservation.md @@ -0,0 +1,38 @@ +## equinix metalv1 hardware-reservations move-hardware-reservation + +Move a hardware reservation + +### Synopsis + +Move a hardware reservation to another project + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 hardware-reservations move-hardware-reservation [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for move-hardware-reservation + --id string Hardware Reservation UUID (required) + --include string include field (JSON or string) + --move-hardware-reservation-request-additional-properties string move-hardware-reservation-request-additional-properties (JSON) + --move-hardware-reservation-request-project_id string move-hardware-reservation-request-project_id + --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 hardware-reservations](equinix_metalv1_hardware-reservations.md) - Manage hardware-reservations resources + diff --git a/docs/equinix_metalv1_i-p-addresses.md b/docs/equinix_metalv1_i-p-addresses.md new file mode 100644 index 0000000..ca38594 --- /dev/null +++ b/docs/equinix_metalv1_i-p-addresses.md @@ -0,0 +1,33 @@ +## 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 new file mode 100644 index 0000000..3c16fb2 --- /dev/null +++ b/docs/equinix_metalv1_i-p-addresses_delete-i-p-address.md @@ -0,0 +1,37 @@ +## 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 new file mode 100644 index 0000000..47c0d26 --- /dev/null +++ b/docs/equinix_metalv1_i-p-addresses_find-i-p-address-by-id.md @@ -0,0 +1,39 @@ +## 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 new file mode 100644 index 0000000..432eff3 --- /dev/null +++ b/docs/equinix_metalv1_i-p-addresses_find-i-p-address-customdata.md @@ -0,0 +1,37 @@ +## 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 new file mode 100644 index 0000000..620fac6 --- /dev/null +++ b/docs/equinix_metalv1_i-p-addresses_find-i-p-availabilities.md @@ -0,0 +1,38 @@ +## 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_find-i-p-reservations.md b/docs/equinix_metalv1_i-p-addresses_find-i-p-reservations.md new file mode 100644 index 0000000..1b75bd8 --- /dev/null +++ b/docs/equinix_metalv1_i-p-addresses_find-i-p-reservations.md @@ -0,0 +1,42 @@ +## equinix metalv1 i-p-addresses find-i-p-reservations + +Execute find-i-p-reservations operation + +### Synopsis + +Execute the find-i-p-reservations 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-reservations [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-i-p-reservations + --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) +``` + +### 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 new file mode 100644 index 0000000..6d48a0c --- /dev/null +++ b/docs/equinix_metalv1_i-p-addresses_request-i-p-reservation.md @@ -0,0 +1,57 @@ +## 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 new file mode 100644 index 0000000..d22f0af --- /dev/null +++ b/docs/equinix_metalv1_i-p-addresses_update-i-p-address.md @@ -0,0 +1,43 @@ +## 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_incidents.md b/docs/equinix_metalv1_incidents.md new file mode 100644 index 0000000..db39fee --- /dev/null +++ b/docs/equinix_metalv1_incidents.md @@ -0,0 +1,27 @@ +## equinix metalv1 incidents + +Manage incidents resources + +### Synopsis + +Commands for managing incidents resources in the API + +### Options + +``` + -h, --help help for incidents +``` + +### 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 incidents find-incidents](equinix_metalv1_incidents_find-incidents.md) - Retrieve the number of incidents + diff --git a/docs/equinix_metalv1_incidents_find-incidents.md b/docs/equinix_metalv1_incidents_find-incidents.md new file mode 100644 index 0000000..0bdbe44 --- /dev/null +++ b/docs/equinix_metalv1_incidents_find-incidents.md @@ -0,0 +1,35 @@ +## equinix metalv1 incidents find-incidents + +Retrieve the number of incidents + +### Synopsis + +Retrieve the number of incidents. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 incidents find-incidents [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-incidents + --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 incidents](equinix_metalv1_incidents.md) - Manage incidents resources + diff --git a/docs/equinix_metalv1_interconnections.md b/docs/equinix_metalv1_interconnections.md new file mode 100644 index 0000000..f8c49de --- /dev/null +++ b/docs/equinix_metalv1_interconnections.md @@ -0,0 +1,43 @@ +## equinix metalv1 interconnections + +Manage interconnections resources + +### Synopsis + +Commands for managing interconnections resources in the API + +### Options + +``` + -h, --help help for interconnections +``` + +### 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 interconnections create-interconnection-port-virtual-circuit](equinix_metalv1_interconnections_create-interconnection-port-virtual-circuit.md) - Create a new Virtual Circuit +* [equinix metalv1 interconnections create-organization-interconnection](equinix_metalv1_interconnections_create-organization-interconnection.md) - Request a new interconnection for the organization +* [equinix metalv1 interconnections create-project-interconnection](equinix_metalv1_interconnections_create-project-interconnection.md) - Request a new interconnection for the project's organization +* [equinix metalv1 interconnections delete-interconnection](equinix_metalv1_interconnections_delete-interconnection.md) - Delete interconnection +* [equinix metalv1 interconnections delete-virtual-circuit](equinix_metalv1_interconnections_delete-virtual-circuit.md) - Delete a virtual circuit +* [equinix metalv1 interconnections get-interconnection](equinix_metalv1_interconnections_get-interconnection.md) - Get interconnection +* [equinix metalv1 interconnections get-interconnection-metros](equinix_metalv1_interconnections_get-interconnection-metros.md) - Get connectivity to network provider by metro +* [equinix metalv1 interconnections get-interconnection-port](equinix_metalv1_interconnections_get-interconnection-port.md) - Get a interconnection port +* [equinix metalv1 interconnections get-interconnection-pricing](equinix_metalv1_interconnections_get-interconnection-pricing.md) - Get Interconnection Pricing +* [equinix metalv1 interconnections get-virtual-circuit](equinix_metalv1_interconnections_get-virtual-circuit.md) - Get a virtual circuit +* [equinix metalv1 interconnections list-interconnection-port-virtual-circuits](equinix_metalv1_interconnections_list-interconnection-port-virtual-circuits.md) - List a interconnection port's virtual circuits +* [equinix metalv1 interconnections list-interconnection-ports](equinix_metalv1_interconnections_list-interconnection-ports.md) - List a interconnection's ports +* [equinix metalv1 interconnections list-interconnection-virtual-circuits](equinix_metalv1_interconnections_list-interconnection-virtual-circuits.md) - List a interconnection's virtual circuits +* [equinix metalv1 interconnections organization-list-interconnections](equinix_metalv1_interconnections_organization-list-interconnections.md) - List organization connections +* [equinix metalv1 interconnections project-list-interconnections](equinix_metalv1_interconnections_project-list-interconnections.md) - List project connections +* [equinix metalv1 interconnections update-interconnection](equinix_metalv1_interconnections_update-interconnection.md) - Update interconnection +* [equinix metalv1 interconnections update-virtual-circuit](equinix_metalv1_interconnections_update-virtual-circuit.md) - Update a virtual circuit + diff --git a/docs/equinix_metalv1_interconnections_create-interconnection-port-virtual-circuit.md b/docs/equinix_metalv1_interconnections_create-interconnection-port-virtual-circuit.md new file mode 100644 index 0000000..5235813 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_create-interconnection-port-virtual-circuit.md @@ -0,0 +1,59 @@ +## equinix metalv1 interconnections create-interconnection-port-virtual-circuit + +Create a new Virtual Circuit + +### Synopsis + +Create a new Virtual Circuit on a Dedicated Port. To create a regular Virtual Circuit, specify a Virtual Network record and an NNI VLAN value. To create a VRF-based Virtual Circuit, specify the VRF ID and subnet, along with the NNI VLAN value. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections create-interconnection-port-virtual-circuit [flags] +``` + +### Options + +``` + --connection-id string UUID of the interconnection (required) + -h, --help help for create-interconnection-port-virtual-circuit + --port-id string UUID of the interconnection port (required) + --request string JSON payload for additional optional fields not exposed as flags + --virtual-circuit-create-input-vlan-virtual-circuit-create-input-additional-properties string virtual-circuit-create-input-vlan-virtual-circuit-create-input-additional-properties (JSON) + --virtual-circuit-create-input-vlan-virtual-circuit-create-input-description string virtual-circuit-create-input-vlan-virtual-circuit-create-input-description + --virtual-circuit-create-input-vlan-virtual-circuit-create-input-name string virtual-circuit-create-input-vlan-virtual-circuit-create-input-name + --virtual-circuit-create-input-vlan-virtual-circuit-create-input-nni_vlan int virtual-circuit-create-input-vlan-virtual-circuit-create-input-nni_vlan + --virtual-circuit-create-input-vlan-virtual-circuit-create-input-project_id string virtual-circuit-create-input-vlan-virtual-circuit-create-input-project_id + --virtual-circuit-create-input-vlan-virtual-circuit-create-input-speed string speed can be passed as integer number representing bps speed or string (e.g. '52m' or '100g' or '4 gbps') + --virtual-circuit-create-input-vlan-virtual-circuit-create-input-tags string virtual-circuit-create-input-vlan-virtual-circuit-create-input-tags (JSON array) + --virtual-circuit-create-input-vlan-virtual-circuit-create-input-vnid string A Virtual Network record UUID or the VNID of a Metro Virtual Network in your project (sent as integer). + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-additional-properties string virtual-circuit-create-input-vrf-virtual-circuit-create-input-additional-properties (JSON) + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-customer_ip string An IPv4 address from the subnet that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Metal IP. By default, the last usable IP address in the subnet will be used. + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-customer_ipv6 string An IPv6 address from the subnet IPv6 that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet IPv6 as the Metal IPv6. By default, the last usable IP address in the subnet IPv6 will be used. + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-description string virtual-circuit-create-input-vrf-virtual-circuit-create-input-description + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-md5 string virtual-circuit-create-input-vrf-virtual-circuit-create-input-md5 (JSON) + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-metal_ip string An IPv4 address from the subnet that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Customer IP. By default, the first usable IP address in the subnet will be used. + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-metal_ipv6 string An IPv6 address from the subnet IPv6 that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IPv6 address in the subnet IPv6 as the Customer IP. By default, the first usable IPv6 address in the subnet IPv6 will be used. + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-name string virtual-circuit-create-input-vrf-virtual-circuit-create-input-name + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-nni_vlan int virtual-circuit-create-input-vrf-virtual-circuit-create-input-nni_vlan + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-peer_asn int The peer ASN that will be used with the VRF on the Virtual Circuit. + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-project_id string virtual-circuit-create-input-vrf-virtual-circuit-create-input-project_id + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-speed string speed can be passed as integer number representing bps speed or string (e.g. '52m' or '100g' or '4 gbps') + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-subnet string The /30 or /31 IPv4 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IP and Customer IP must be IPs from this subnet. For /30 subnets, the network and broadcast IPs cannot be used as the Metal or Customer IP. The subnet specified must be contained within an already-defined IP Range for the VRF. + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-subnet_ipv6 string The /126 or /127 IPv6 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IPv6 and Customer IPv6 must be IPs from this subnet. For /126 subnets, the network and broadcast IPs cannot be used as the Metal IPv6 or Customer IPv6. The subnet specified must be contained within an already-defined IP Range for the VRF. + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-tags string virtual-circuit-create-input-vrf-virtual-circuit-create-input-tags (JSON array) + --virtual-circuit-create-input-vrf-virtual-circuit-create-input-vrf string The UUID of the VRF that will be associated with the Virtual Circuit. +``` + +### 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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_create-organization-interconnection.md b/docs/equinix_metalv1_interconnections_create-organization-interconnection.md new file mode 100644 index 0000000..8d5ef92 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_create-organization-interconnection.md @@ -0,0 +1,97 @@ +## equinix metalv1 interconnections create-organization-interconnection + +Request a new interconnection for the organization + +### Synopsis + +Creates a new interconnection request. A Project ID must be specified in the request body for connections on shared ports. + +Use --request flag to provide optional JSON payload fields. + +``` +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 +``` + +### 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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_create-project-interconnection.md b/docs/equinix_metalv1_interconnections_create-project-interconnection.md new file mode 100644 index 0000000..91ca47b --- /dev/null +++ b/docs/equinix_metalv1_interconnections_create-project-interconnection.md @@ -0,0 +1,97 @@ +## equinix metalv1 interconnections create-project-interconnection + +Request a new interconnection for the project's organization + +### Synopsis + +Creates a new interconnection request + +Use --request flag to provide optional JSON payload fields. + +``` +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 +``` + +### 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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_delete-interconnection.md b/docs/equinix_metalv1_interconnections_delete-interconnection.md new file mode 100644 index 0000000..e215aa1 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_delete-interconnection.md @@ -0,0 +1,36 @@ +## equinix metalv1 interconnections delete-interconnection + +Delete interconnection + +### Synopsis + +Delete a interconnection, its associated ports and virtual circuits. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections delete-interconnection [flags] +``` + +### Options + +``` + --connection-id string Interconnection UUID (required) + --exclude string exclude field (JSON or string) + -h, --help help for delete-interconnection + --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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_delete-virtual-circuit.md b/docs/equinix_metalv1_interconnections_delete-virtual-circuit.md new file mode 100644 index 0000000..76ce1c8 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_delete-virtual-circuit.md @@ -0,0 +1,36 @@ +## equinix metalv1 interconnections delete-virtual-circuit + +Delete a virtual circuit + +### Synopsis + +Delete a virtual circuit from a Dedicated Port. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections delete-virtual-circuit [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for delete-virtual-circuit + --id string Virtual Circuit 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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_get-interconnection-metros.md b/docs/equinix_metalv1_interconnections_get-interconnection-metros.md new file mode 100644 index 0000000..6b2ff1d --- /dev/null +++ b/docs/equinix_metalv1_interconnections_get-interconnection-metros.md @@ -0,0 +1,33 @@ +## equinix metalv1 interconnections get-interconnection-metros + +Get connectivity to network provider by metro + +### Synopsis + +Displays which providers you can connect to directly from Equinix Metal Metros. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections get-interconnection-metros [flags] +``` + +### Options + +``` + -h, --help help for get-interconnection-metros + --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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_get-interconnection-port.md b/docs/equinix_metalv1_interconnections_get-interconnection-port.md new file mode 100644 index 0000000..53f0589 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_get-interconnection-port.md @@ -0,0 +1,37 @@ +## equinix metalv1 interconnections get-interconnection-port + +Get a interconnection port + +### Synopsis + +Get the details of an interconnection port. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections get-interconnection-port [flags] +``` + +### Options + +``` + --connection-id string UUID of the interconnection (required) + --exclude string exclude field (JSON or string) + -h, --help help for get-interconnection-port + --id string Port 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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_get-interconnection-pricing.md b/docs/equinix_metalv1_interconnections_get-interconnection-pricing.md new file mode 100644 index 0000000..a77fb61 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_get-interconnection-pricing.md @@ -0,0 +1,33 @@ +## equinix metalv1 interconnections get-interconnection-pricing + +Get Interconnection Pricing + +### Synopsis + +Displays pricing information for connecting to networks outside of Equinix. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections get-interconnection-pricing [flags] +``` + +### Options + +``` + -h, --help help for get-interconnection-pricing + --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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_get-interconnection.md b/docs/equinix_metalv1_interconnections_get-interconnection.md new file mode 100644 index 0000000..32b4cc9 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_get-interconnection.md @@ -0,0 +1,36 @@ +## equinix metalv1 interconnections get-interconnection + +Get interconnection + +### Synopsis + +Get the details of a interconnection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections get-interconnection [flags] +``` + +### Options + +``` + --connection-id string Interconnection UUID (required) + --exclude string exclude field (JSON or string) + -h, --help help for get-interconnection + --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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_get-virtual-circuit.md b/docs/equinix_metalv1_interconnections_get-virtual-circuit.md new file mode 100644 index 0000000..a9e0dc0 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_get-virtual-circuit.md @@ -0,0 +1,36 @@ +## equinix metalv1 interconnections get-virtual-circuit + +Get a virtual circuit + +### Synopsis + +Get the details of a virtual circuit + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections get-virtual-circuit [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for get-virtual-circuit + --id string Virtual Circuit 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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_list-interconnection-port-virtual-circuits.md b/docs/equinix_metalv1_interconnections_list-interconnection-port-virtual-circuits.md new file mode 100644 index 0000000..94058bb --- /dev/null +++ b/docs/equinix_metalv1_interconnections_list-interconnection-port-virtual-circuits.md @@ -0,0 +1,37 @@ +## equinix metalv1 interconnections list-interconnection-port-virtual-circuits + +List a interconnection port's virtual circuits + +### Synopsis + +List the virtual circuit record(s) associatiated with a particular interconnection port. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections list-interconnection-port-virtual-circuits [flags] +``` + +### Options + +``` + --connection-id string UUID of the interconnection (required) + --exclude string exclude field (JSON or string) + -h, --help help for list-interconnection-port-virtual-circuits + --include string include field (JSON or string) + --port-id string UUID of the interconnection port (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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_list-interconnection-ports.md b/docs/equinix_metalv1_interconnections_list-interconnection-ports.md new file mode 100644 index 0000000..46ff6a0 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_list-interconnection-ports.md @@ -0,0 +1,34 @@ +## equinix metalv1 interconnections list-interconnection-ports + +List a interconnection's ports + +### Synopsis + +List the ports associated to an interconnection. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections list-interconnection-ports [flags] +``` + +### Options + +``` + --connection-id string UUID of the interconnection (required) + -h, --help help for list-interconnection-ports + --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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_list-interconnection-virtual-circuits.md b/docs/equinix_metalv1_interconnections_list-interconnection-virtual-circuits.md new file mode 100644 index 0000000..8b07d01 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_list-interconnection-virtual-circuits.md @@ -0,0 +1,34 @@ +## equinix metalv1 interconnections list-interconnection-virtual-circuits + +List a interconnection's virtual circuits + +### Synopsis + +List the virtual circuit record(s) associated with a particular interconnection id. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections list-interconnection-virtual-circuits [flags] +``` + +### Options + +``` + --connection-id string UUID of the interconnection (required) + -h, --help help for list-interconnection-virtual-circuits + --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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_organization-list-interconnections.md b/docs/equinix_metalv1_interconnections_organization-list-interconnections.md new file mode 100644 index 0000000..c1241e7 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_organization-list-interconnections.md @@ -0,0 +1,36 @@ +## equinix metalv1 interconnections organization-list-interconnections + +List organization connections + +### Synopsis + +List the connections belonging to the organization + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections organization-list-interconnections [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for organization-list-interconnections + --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 + +``` + --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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_project-list-interconnections.md b/docs/equinix_metalv1_interconnections_project-list-interconnections.md new file mode 100644 index 0000000..8e3b852 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_project-list-interconnections.md @@ -0,0 +1,38 @@ +## equinix metalv1 interconnections project-list-interconnections + +List project connections + +### Synopsis + +List the connections belonging to the project + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections project-list-interconnections [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for project-list-interconnections + --include string include field (JSON or string) + --page int page field + --per-page int per-page field + --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 + +``` + --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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_update-interconnection.md b/docs/equinix_metalv1_interconnections_update-interconnection.md new file mode 100644 index 0000000..16e8cb0 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_update-interconnection.md @@ -0,0 +1,42 @@ +## equinix metalv1 interconnections update-interconnection + +Update interconnection + +### Synopsis + +Update the details of a interconnection + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections update-interconnection [flags] +``` + +### Options + +``` + --connection-id string Interconnection UUID (required) + --exclude string exclude field (JSON or string) + -h, --help help for update-interconnection + --include string include field (JSON or string) + --interconnection-update-input-additional-properties string interconnection-update-input-additional-properties (JSON) + --interconnection-update-input-contact_email string interconnection-update-input-contact_email + --interconnection-update-input-description string interconnection-update-input-description + --interconnection-update-input-mode string interconnection-update-input-mode + --interconnection-update-input-name string interconnection-update-input-name + --interconnection-update-input-tags string interconnection-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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_interconnections_update-virtual-circuit.md b/docs/equinix_metalv1_interconnections_update-virtual-circuit.md new file mode 100644 index 0000000..987aed6 --- /dev/null +++ b/docs/equinix_metalv1_interconnections_update-virtual-circuit.md @@ -0,0 +1,55 @@ +## equinix metalv1 interconnections update-virtual-circuit + +Update a virtual circuit + +### Synopsis + +Update the details of a virtual circuit. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 interconnections update-virtual-circuit [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for update-virtual-circuit + --id string Virtual Circuit UUID (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --virtual-circuit-update-input-vlan-virtual-circuit-update-input-additional-properties string virtual-circuit-update-input-vlan-virtual-circuit-update-input-additional-properties (JSON) + --virtual-circuit-update-input-vlan-virtual-circuit-update-input-description string virtual-circuit-update-input-vlan-virtual-circuit-update-input-description + --virtual-circuit-update-input-vlan-virtual-circuit-update-input-name string virtual-circuit-update-input-vlan-virtual-circuit-update-input-name + --virtual-circuit-update-input-vlan-virtual-circuit-update-input-speed string Speed can be changed only if it is an interconnection on a Dedicated Port + --virtual-circuit-update-input-vlan-virtual-circuit-update-input-tags string virtual-circuit-update-input-vlan-virtual-circuit-update-input-tags (JSON array) + --virtual-circuit-update-input-vlan-virtual-circuit-update-input-vnid string A Virtual Network record UUID or the VNID of a Metro Virtual Network in your project. + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-additional-properties string virtual-circuit-update-input-vrf-virtual-circuit-update-input-additional-properties (JSON) + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-customer_ip string An IPv4 address from the subnet that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Metal IP. By default, the last usable IP address in the subnet will be used. + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-customer_ipv6 string An IPv6 address from the subnet IPv6 that will be used on the Customer side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet IPv6 as the Metal IPv6. By default, the last usable IP address in the subnet IPv6 will be used. + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-description string virtual-circuit-update-input-vrf-virtual-circuit-update-input-description + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-md5 string The plaintext BGP peering password shared by 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 + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-metal_ip string An IPv4 address from the subnet that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IP address in the subnet as the Customer IP. By default, the first usable IP address in the subnet will be used. + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-metal_ipv6 string An IPv6 address from the subnet IPv6 that will be used on the Metal side. This parameter is optional, but if supplied, we will use the other usable IPv6 address in the subnet IPv6 as the Customer IP. By default, the first usable IPv6 address in the subnet IPv6 will be used. + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-name string virtual-circuit-update-input-vrf-virtual-circuit-update-input-name + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-peer_asn int The peer ASN that will be used with the VRF on the Virtual Circuit. + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-speed string Speed can be changed only if it is an interconnection on a Dedicated Port + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-subnet string The /30 or /31 IPv4 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IP and Customer IP must be IPs from this subnet. For /30 subnets, the network and broadcast IPs cannot be used as the Metal or Customer IP. + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-subnet_ipv6 string The /126 or /127 IPv6 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. This subnet does not have to be an existing VRF IP reservation, as we will create the VRF IP reservation on creation if it does not exist. The Metal IPv6 and Customer IPv6 must be IPs from this subnet. For /126 subnets, the network and broadcast IPs cannot be used as the Metal IPv6 or Customer IPv6. The subnet specified must be contained within an already-defined IP Range for the VRF. + --virtual-circuit-update-input-vrf-virtual-circuit-update-input-tags string virtual-circuit-update-input-vrf-virtual-circuit-update-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 interconnections](equinix_metalv1_interconnections.md) - Manage interconnections resources + diff --git a/docs/equinix_metalv1_invitations.md b/docs/equinix_metalv1_invitations.md new file mode 100644 index 0000000..034ecb9 --- /dev/null +++ b/docs/equinix_metalv1_invitations.md @@ -0,0 +1,29 @@ +## equinix metalv1 invitations + +Manage invitations resources + +### Synopsis + +Commands for managing invitations resources in the API + +### Options + +``` + -h, --help help for invitations +``` + +### 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 invitations accept-invitation](equinix_metalv1_invitations_accept-invitation.md) - Accept an invitation +* [equinix metalv1 invitations decline-invitation](equinix_metalv1_invitations_decline-invitation.md) - Decline an invitation +* [equinix metalv1 invitations find-invitation-by-id](equinix_metalv1_invitations_find-invitation-by-id.md) - View an invitation + diff --git a/docs/equinix_metalv1_invitations_accept-invitation.md b/docs/equinix_metalv1_invitations_accept-invitation.md new file mode 100644 index 0000000..e11721b --- /dev/null +++ b/docs/equinix_metalv1_invitations_accept-invitation.md @@ -0,0 +1,35 @@ +## equinix metalv1 invitations accept-invitation + +Accept an invitation + +### Synopsis + +Accept an invitation. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 invitations accept-invitation [flags] +``` + +### Options + +``` + -h, --help help for accept-invitation + --id string Invitation 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 invitations](equinix_metalv1_invitations.md) - Manage invitations resources + diff --git a/docs/equinix_metalv1_invitations_decline-invitation.md b/docs/equinix_metalv1_invitations_decline-invitation.md new file mode 100644 index 0000000..8196a0a --- /dev/null +++ b/docs/equinix_metalv1_invitations_decline-invitation.md @@ -0,0 +1,34 @@ +## equinix metalv1 invitations decline-invitation + +Decline an invitation + +### Synopsis + +Decline an invitation. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 invitations decline-invitation [flags] +``` + +### Options + +``` + -h, --help help for decline-invitation + --id string Invitation 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 invitations](equinix_metalv1_invitations.md) - Manage invitations resources + diff --git a/docs/equinix_metalv1_invitations_find-invitation-by-id.md b/docs/equinix_metalv1_invitations_find-invitation-by-id.md new file mode 100644 index 0000000..c793127 --- /dev/null +++ b/docs/equinix_metalv1_invitations_find-invitation-by-id.md @@ -0,0 +1,35 @@ +## equinix metalv1 invitations find-invitation-by-id + +View an invitation + +### Synopsis + +Returns a single invitation. (It include the `invitable` to maintain backward compatibility but will be removed soon) + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 invitations find-invitation-by-id [flags] +``` + +### Options + +``` + -h, --help help for find-invitation-by-id + --id string Invitation 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 invitations](equinix_metalv1_invitations.md) - Manage invitations resources + diff --git a/docs/equinix_metalv1_invoices.md b/docs/equinix_metalv1_invoices.md new file mode 100644 index 0000000..3e395c5 --- /dev/null +++ b/docs/equinix_metalv1_invoices.md @@ -0,0 +1,28 @@ +## equinix metalv1 invoices + +Manage invoices resources + +### Synopsis + +Commands for managing invoices resources in the API + +### Options + +``` + -h, --help help for invoices +``` + +### 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 invoices find-organization-invoices](equinix_metalv1_invoices_find-organization-invoices.md) - Retrieve all invoices for an organization +* [equinix metalv1 invoices get-invoice-by-id](equinix_metalv1_invoices_get-invoice-by-id.md) - Retrieve an invoice + diff --git a/docs/equinix_metalv1_invoices_find-organization-invoices.md b/docs/equinix_metalv1_invoices_find-organization-invoices.md new file mode 100644 index 0000000..938a222 --- /dev/null +++ b/docs/equinix_metalv1_invoices_find-organization-invoices.md @@ -0,0 +1,37 @@ +## equinix metalv1 invoices find-organization-invoices + +Retrieve all invoices for an organization + +### Synopsis + +Returns all invoices for an organization + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 invoices find-organization-invoices [flags] +``` + +### Options + +``` + -h, --help help for find-organization-invoices + --id string Organization UUID (required) + --page int page field + --per-page int per-page field + --request string JSON payload for additional optional fields not exposed as flags + --status string status 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 invoices](equinix_metalv1_invoices.md) - Manage invoices resources + diff --git a/docs/equinix_metalv1_invoices_get-invoice-by-id.md b/docs/equinix_metalv1_invoices_get-invoice-by-id.md new file mode 100644 index 0000000..8aa8656 --- /dev/null +++ b/docs/equinix_metalv1_invoices_get-invoice-by-id.md @@ -0,0 +1,34 @@ +## equinix metalv1 invoices get-invoice-by-id + +Retrieve an invoice + +### Synopsis + +Returns the invoice identified by the provided id + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 invoices get-invoice-by-id [flags] +``` + +### Options + +``` + -h, --help help for get-invoice-by-id + --id string Invoice 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 invoices](equinix_metalv1_invoices.md) - Manage invoices resources + diff --git a/docs/equinix_metalv1_licenses.md b/docs/equinix_metalv1_licenses.md new file mode 100644 index 0000000..5725a49 --- /dev/null +++ b/docs/equinix_metalv1_licenses.md @@ -0,0 +1,31 @@ +## equinix metalv1 licenses + +Manage licenses resources + +### Synopsis + +Commands for managing licenses resources in the API + +### Options + +``` + -h, --help help for licenses +``` + +### 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 licenses create-license](equinix_metalv1_licenses_create-license.md) - Create a License +* [equinix metalv1 licenses delete-license](equinix_metalv1_licenses_delete-license.md) - Delete the license +* [equinix metalv1 licenses find-license-by-id](equinix_metalv1_licenses_find-license-by-id.md) - Retrieve a license +* [equinix metalv1 licenses find-project-licenses](equinix_metalv1_licenses_find-project-licenses.md) - Retrieve all licenses +* [equinix metalv1 licenses update-license](equinix_metalv1_licenses_update-license.md) - Update the license + diff --git a/docs/equinix_metalv1_licenses_create-license.md b/docs/equinix_metalv1_licenses_create-license.md new file mode 100644 index 0000000..01dc06e --- /dev/null +++ b/docs/equinix_metalv1_licenses_create-license.md @@ -0,0 +1,40 @@ +## equinix metalv1 licenses create-license + +Create a License + +### Synopsis + +Creates a new license for the given project + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 licenses create-license [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for create-license + --id string Project UUID (required) + --include string include field (JSON or string) + --license-create-input-additional-properties string license-create-input-additional-properties (JSON) + --license-create-input-description string license-create-input-description + --license-create-input-licensee_product_id string license-create-input-licensee_product_id + --license-create-input-size float license-create-input-size + --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 licenses](equinix_metalv1_licenses.md) - Manage licenses resources + diff --git a/docs/equinix_metalv1_licenses_delete-license.md b/docs/equinix_metalv1_licenses_delete-license.md new file mode 100644 index 0000000..6806b5f --- /dev/null +++ b/docs/equinix_metalv1_licenses_delete-license.md @@ -0,0 +1,34 @@ +## equinix metalv1 licenses delete-license + +Delete the license + +### Synopsis + +Deletes a license. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 licenses delete-license [flags] +``` + +### Options + +``` + -h, --help help for delete-license + --id string License 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 licenses](equinix_metalv1_licenses.md) - Manage licenses resources + diff --git a/docs/equinix_metalv1_licenses_find-license-by-id.md b/docs/equinix_metalv1_licenses_find-license-by-id.md new file mode 100644 index 0000000..69171e3 --- /dev/null +++ b/docs/equinix_metalv1_licenses_find-license-by-id.md @@ -0,0 +1,36 @@ +## equinix metalv1 licenses find-license-by-id + +Retrieve a license + +### Synopsis + +Returns a license + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 licenses find-license-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-license-by-id + --id string License 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 licenses](equinix_metalv1_licenses.md) - Manage licenses resources + diff --git a/docs/equinix_metalv1_licenses_find-project-licenses.md b/docs/equinix_metalv1_licenses_find-project-licenses.md new file mode 100644 index 0000000..3180548 --- /dev/null +++ b/docs/equinix_metalv1_licenses_find-project-licenses.md @@ -0,0 +1,38 @@ +## equinix metalv1 licenses find-project-licenses + +Retrieve all licenses + +### Synopsis + +Provides a collection of licenses for a given project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 licenses find-project-licenses [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-project-licenses + --id string Project UUID (required) + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 licenses](equinix_metalv1_licenses.md) - Manage licenses resources + diff --git a/docs/equinix_metalv1_licenses_update-license.md b/docs/equinix_metalv1_licenses_update-license.md new file mode 100644 index 0000000..35ed0f0 --- /dev/null +++ b/docs/equinix_metalv1_licenses_update-license.md @@ -0,0 +1,39 @@ +## equinix metalv1 licenses update-license + +Update the license + +### Synopsis + +Updates the license. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 licenses update-license [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for update-license + --id string License UUID (required) + --include string include field (JSON or string) + --license-update-input-additional-properties string license-update-input-additional-properties (JSON) + --license-update-input-description string license-update-input-description + --license-update-input-size float license-update-input-size + --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 licenses](equinix_metalv1_licenses.md) - Manage licenses resources + diff --git a/docs/equinix_metalv1_memberships.md b/docs/equinix_metalv1_memberships.md new file mode 100644 index 0000000..423f51b --- /dev/null +++ b/docs/equinix_metalv1_memberships.md @@ -0,0 +1,29 @@ +## equinix metalv1 memberships + +Manage memberships resources + +### Synopsis + +Commands for managing memberships resources in the API + +### Options + +``` + -h, --help help for memberships +``` + +### 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 memberships delete-membership](equinix_metalv1_memberships_delete-membership.md) - Delete the membership +* [equinix metalv1 memberships find-membership-by-id](equinix_metalv1_memberships_find-membership-by-id.md) - Retrieve a membership +* [equinix metalv1 memberships update-membership](equinix_metalv1_memberships_update-membership.md) - Update the membership + diff --git a/docs/equinix_metalv1_memberships_delete-membership.md b/docs/equinix_metalv1_memberships_delete-membership.md new file mode 100644 index 0000000..393dae9 --- /dev/null +++ b/docs/equinix_metalv1_memberships_delete-membership.md @@ -0,0 +1,34 @@ +## equinix metalv1 memberships delete-membership + +Delete the membership + +### Synopsis + +Deletes the membership. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 memberships delete-membership [flags] +``` + +### Options + +``` + -h, --help help for delete-membership + --id string Membership 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 memberships](equinix_metalv1_memberships.md) - Manage memberships resources + diff --git a/docs/equinix_metalv1_memberships_find-membership-by-id.md b/docs/equinix_metalv1_memberships_find-membership-by-id.md new file mode 100644 index 0000000..a7b09df --- /dev/null +++ b/docs/equinix_metalv1_memberships_find-membership-by-id.md @@ -0,0 +1,35 @@ +## equinix metalv1 memberships find-membership-by-id + +Retrieve a membership + +### Synopsis + +Returns a single membership. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 memberships find-membership-by-id [flags] +``` + +### Options + +``` + -h, --help help for find-membership-by-id + --id string Membership 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 memberships](equinix_metalv1_memberships.md) - Manage memberships resources + diff --git a/docs/equinix_metalv1_memberships_update-membership.md b/docs/equinix_metalv1_memberships_update-membership.md new file mode 100644 index 0000000..f0a4e50 --- /dev/null +++ b/docs/equinix_metalv1_memberships_update-membership.md @@ -0,0 +1,37 @@ +## equinix metalv1 memberships update-membership + +Update the membership + +### Synopsis + +Updates the membership. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 memberships update-membership [flags] +``` + +### Options + +``` + -h, --help help for update-membership + --id string Membership UUID (required) + --include string include field (JSON or string) + --membership-input-additional-properties string membership-input-additional-properties (JSON) + --membership-input-role string membership-input-role (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 memberships](equinix_metalv1_memberships.md) - Manage memberships resources + diff --git a/docs/equinix_metalv1_metal-gateways.md b/docs/equinix_metalv1_metal-gateways.md new file mode 100644 index 0000000..2c52fe3 --- /dev/null +++ b/docs/equinix_metalv1_metal-gateways.md @@ -0,0 +1,34 @@ +## equinix metalv1 metal-gateways + +Manage metal-gateways resources + +### Synopsis + +Commands for managing metal-gateways resources in the API + +### Options + +``` + -h, --help help for metal-gateways +``` + +### 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 metal-gateways create-bgp-dynamic-neighbor](equinix_metalv1_metal-gateways_create-bgp-dynamic-neighbor.md) - Create a VRF BGP Dynamic Neighbor range +* [equinix metalv1 metal-gateways create-metal-gateway](equinix_metalv1_metal-gateways_create-metal-gateway.md) - Create a metal gateway +* [equinix metalv1 metal-gateways create-metal-gateway-elastic-ip](equinix_metalv1_metal-gateways_create-metal-gateway-elastic-ip.md) - Create a Metal Gateway Elastic IP +* [equinix metalv1 metal-gateways delete-metal-gateway](equinix_metalv1_metal-gateways_delete-metal-gateway.md) - Deletes the metal gateway +* [equinix metalv1 metal-gateways find-metal-gateway-by-id](equinix_metalv1_metal-gateways_find-metal-gateway-by-id.md) - Returns the metal gateway +* [equinix metalv1 metal-gateways find-metal-gateways-by-project](equinix_metalv1_metal-gateways_find-metal-gateways-by-project.md) - Returns all metal gateways for a project +* [equinix metalv1 metal-gateways get-bgp-dynamic-neighbors](equinix_metalv1_metal-gateways_get-bgp-dynamic-neighbors.md) - List BGP Dynamic Neighbors +* [equinix metalv1 metal-gateways get-metal-gateway-elastic-ips](equinix_metalv1_metal-gateways_get-metal-gateway-elastic-ips.md) - List Metal Gateway Elastic IPs + diff --git a/docs/equinix_metalv1_metal-gateways_create-bgp-dynamic-neighbor.md b/docs/equinix_metalv1_metal-gateways_create-bgp-dynamic-neighbor.md new file mode 100644 index 0000000..933ea2c --- /dev/null +++ b/docs/equinix_metalv1_metal-gateways_create-bgp-dynamic-neighbor.md @@ -0,0 +1,40 @@ +## equinix metalv1 metal-gateways create-bgp-dynamic-neighbor + +Create a VRF BGP Dynamic Neighbor range + +### Synopsis + +Create a VRF BGP Dynamic Neighbor range. BGP Dynamic Neighbor records are limited to 2 per Virtual Network. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 metal-gateways create-bgp-dynamic-neighbor [flags] +``` + +### Options + +``` + --bgp-dynamic-neighbor-create-input-additional-properties string bgp-dynamic-neighbor-create-input-additional-properties (JSON) + --bgp-dynamic-neighbor-create-input-bgp_neighbor_asn int The ASN of the dynamic BGP neighbor + --bgp-dynamic-neighbor-create-input-bgp_neighbor_range string Network range of the dynamic BGP neighbor in CIDR format + --bgp-dynamic-neighbor-create-input-tags string bgp-dynamic-neighbor-create-input-tags (JSON array) + --exclude string exclude field (JSON or string) + -h, --help help for create-bgp-dynamic-neighbor + --id string Metal Gateway 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 metal-gateways](equinix_metalv1_metal-gateways.md) - Manage metal-gateways resources + diff --git a/docs/equinix_metalv1_metal-gateways_create-metal-gateway-elastic-ip.md b/docs/equinix_metalv1_metal-gateways_create-metal-gateway-elastic-ip.md new file mode 100644 index 0000000..0369404 --- /dev/null +++ b/docs/equinix_metalv1_metal-gateways_create-metal-gateway-elastic-ip.md @@ -0,0 +1,41 @@ +## equinix metalv1 metal-gateways create-metal-gateway-elastic-ip + +Create a Metal Gateway Elastic IP + +### Synopsis + +Create a new Elastic IP on this Metal Gateway. Assign an IPv4 range as an elastic IP to the Metal Gateway, with a specified next-hop address contained within the Metal Gateway. Notice: Elastic IPs on Metal Gateways are a test feature currently under active development, and only available to certain users. Please contact Customer Success for more information. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 metal-gateways create-metal-gateway-elastic-ip [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for create-metal-gateway-elastic-ip + --id string Metal Gateway UUID (required) + --include string include field (JSON or string) + --metal-gateway-elastic-ip-create-input-additional-properties string metal-gateway-elastic-ip-create-input-additional-properties (JSON) + --metal-gateway-elastic-ip-create-input-address string An IP address (or IP Address range) contained within one of the project's IP Reservations + --metal-gateway-elastic-ip-create-input-customdata string Optional User-defined JSON object value. (JSON) + --metal-gateway-elastic-ip-create-input-next_hop string An IP address contained within the Metal Gateways' IP Reservation range. + --metal-gateway-elastic-ip-create-input-tags string Optional list of User-defined tags. Can be used by users to provide additional details or context regarding the purpose or usage of this resource. (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 metal-gateways](equinix_metalv1_metal-gateways.md) - Manage metal-gateways resources + diff --git a/docs/equinix_metalv1_metal-gateways_create-metal-gateway.md b/docs/equinix_metalv1_metal-gateways_create-metal-gateway.md new file mode 100644 index 0000000..3a4e176 --- /dev/null +++ b/docs/equinix_metalv1_metal-gateways_create-metal-gateway.md @@ -0,0 +1,45 @@ +## equinix metalv1 metal-gateways create-metal-gateway + +Create a metal gateway + +### Synopsis + +Create a metal gateway in a project + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 metal-gateways create-metal-gateway [flags] +``` + +### Options + +``` + --create-metal-gateway-request-metal-gateway-create-input-additional-properties string create-metal-gateway-request-metal-gateway-create-input-additional-properties (JSON) + --create-metal-gateway-request-metal-gateway-create-input-ip_reservation_id string The UUID of an IP reservation that belongs to the same project as where the metal gateway will be created in. This field is required unless the private IPv4 subnet size is specified. + --create-metal-gateway-request-metal-gateway-create-input-private_ipv4_subnet_size int The subnet size (8, 16, 32, 64, or 128) of the private IPv4 reservation that will be created for the metal gateway. This field is required unless a project IP reservation was specified. Please keep in mind that the number of private metal gateway ranges are limited per project. If you would like to increase the limit per project, please contact support for assistance. + --create-metal-gateway-request-metal-gateway-create-input-virtual_network_id string The UUID of a metro virtual network that belongs to the same project as where the metal gateway will be created in. + --create-metal-gateway-request-vrf-metal-gateway-create-input-additional-properties string create-metal-gateway-request-vrf-metal-gateway-create-input-additional-properties (JSON) + --create-metal-gateway-request-vrf-metal-gateway-create-input-ip_reservation_id string The UUID an a VRF IP Reservation that belongs to the same project as the one in which the Metal Gateway is to be created. Additionally, the VRF IP Reservation and the Virtual Network must reside in the same Metro. + --create-metal-gateway-request-vrf-metal-gateway-create-input-virtual_network_id string The UUID of a Metro Virtual Network that belongs to the same project as the one in which the Metal Gateway is to be created. Additionally, the Virtual Network and the VRF IP Reservation must reside in the same metro. In the case of the IP reservation being an IPv6 based VRF IP Reservation, the Virtual Network must not already have an associated IPv6 based VRF IP Reservation. There can be exactly one IPv6 based VRF IP Reservation associated to a Virtual Network. + --exclude string exclude field (JSON or string) + -h, --help help for create-metal-gateway + --include string include field (JSON or string) + --page int page field + --per-page int per-page field + --project-id string Project 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 metal-gateways](equinix_metalv1_metal-gateways.md) - Manage metal-gateways resources + diff --git a/docs/equinix_metalv1_metal-gateways_delete-metal-gateway.md b/docs/equinix_metalv1_metal-gateways_delete-metal-gateway.md new file mode 100644 index 0000000..07a9b78 --- /dev/null +++ b/docs/equinix_metalv1_metal-gateways_delete-metal-gateway.md @@ -0,0 +1,36 @@ +## equinix metalv1 metal-gateways delete-metal-gateway + +Deletes the metal gateway + +### Synopsis + +Deletes a metal gateway and any elastic IP assignments associated with this metal gateway. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 metal-gateways delete-metal-gateway [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for delete-metal-gateway + --id string Metal Gateway 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 metal-gateways](equinix_metalv1_metal-gateways.md) - Manage metal-gateways resources + diff --git a/docs/equinix_metalv1_metal-gateways_find-metal-gateway-by-id.md b/docs/equinix_metalv1_metal-gateways_find-metal-gateway-by-id.md new file mode 100644 index 0000000..91203c7 --- /dev/null +++ b/docs/equinix_metalv1_metal-gateways_find-metal-gateway-by-id.md @@ -0,0 +1,36 @@ +## equinix metalv1 metal-gateways find-metal-gateway-by-id + +Returns the metal gateway + +### Synopsis + +Returns a specific metal gateway + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 metal-gateways find-metal-gateway-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-metal-gateway-by-id + --id string Metal Gateway 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 metal-gateways](equinix_metalv1_metal-gateways.md) - Manage metal-gateways resources + diff --git a/docs/equinix_metalv1_metal-gateways_find-metal-gateways-by-project.md b/docs/equinix_metalv1_metal-gateways_find-metal-gateways-by-project.md new file mode 100644 index 0000000..1317cf5 --- /dev/null +++ b/docs/equinix_metalv1_metal-gateways_find-metal-gateways-by-project.md @@ -0,0 +1,38 @@ +## equinix metalv1 metal-gateways find-metal-gateways-by-project + +Returns all metal gateways for a project + +### Synopsis + +Return all metal gateways for a project + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 metal-gateways find-metal-gateways-by-project [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-metal-gateways-by-project + --include string include field (JSON or string) + --page int page field + --per-page int per-page field + --project-id string Project 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 metal-gateways](equinix_metalv1_metal-gateways.md) - Manage metal-gateways resources + diff --git a/docs/equinix_metalv1_metal-gateways_get-bgp-dynamic-neighbors.md b/docs/equinix_metalv1_metal-gateways_get-bgp-dynamic-neighbors.md new file mode 100644 index 0000000..4b7e8c4 --- /dev/null +++ b/docs/equinix_metalv1_metal-gateways_get-bgp-dynamic-neighbors.md @@ -0,0 +1,36 @@ +## equinix metalv1 metal-gateways get-bgp-dynamic-neighbors + +List BGP Dynamic Neighbors + +### Synopsis + +Returns the list of VRF BGP Dynamic Neighbors for this Metal Gateway + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 metal-gateways get-bgp-dynamic-neighbors [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for get-bgp-dynamic-neighbors + --id string Metal Gateway 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 metal-gateways](equinix_metalv1_metal-gateways.md) - Manage metal-gateways resources + diff --git a/docs/equinix_metalv1_metal-gateways_get-metal-gateway-elastic-ips.md b/docs/equinix_metalv1_metal-gateways_get-metal-gateway-elastic-ips.md new file mode 100644 index 0000000..6f7811b --- /dev/null +++ b/docs/equinix_metalv1_metal-gateways_get-metal-gateway-elastic-ips.md @@ -0,0 +1,36 @@ +## equinix metalv1 metal-gateways get-metal-gateway-elastic-ips + +List Metal Gateway Elastic IPs + +### Synopsis + +Returns the list of Elastic IPs assigned to this Metal Gateway + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 metal-gateways get-metal-gateway-elastic-ips [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for get-metal-gateway-elastic-ips + --id string Metal Gateway 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 metal-gateways](equinix_metalv1_metal-gateways.md) - Manage metal-gateways resources + diff --git a/docs/equinix_metalv1_metros.md b/docs/equinix_metalv1_metros.md new file mode 100644 index 0000000..110fa37 --- /dev/null +++ b/docs/equinix_metalv1_metros.md @@ -0,0 +1,28 @@ +## equinix metalv1 metros + +Manage metros resources + +### Synopsis + +Commands for managing metros resources in the API + +### Options + +``` + -h, --help help for metros +``` + +### 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 metros find-metros](equinix_metalv1_metros_find-metros.md) - Retrieve all metros +* [equinix metalv1 metros get-metro](equinix_metalv1_metros_get-metro.md) - Retrieve a specific Metro's details + diff --git a/docs/equinix_metalv1_metros_find-metros.md b/docs/equinix_metalv1_metros_find-metros.md new file mode 100644 index 0000000..b95b49f --- /dev/null +++ b/docs/equinix_metalv1_metros_find-metros.md @@ -0,0 +1,33 @@ +## equinix metalv1 metros find-metros + +Retrieve all metros + +### Synopsis + +Provides a listing of available metros + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 metros find-metros [flags] +``` + +### Options + +``` + -h, --help help for find-metros + --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 metros](equinix_metalv1_metros.md) - Manage metros resources + diff --git a/docs/equinix_metalv1_metros_get-metro.md b/docs/equinix_metalv1_metros_get-metro.md new file mode 100644 index 0000000..bb3b777 --- /dev/null +++ b/docs/equinix_metalv1_metros_get-metro.md @@ -0,0 +1,34 @@ +## equinix metalv1 metros get-metro + +Retrieve a specific Metro's details + +### Synopsis + +Show the details for a metro, including name, code, and country. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 metros get-metro [flags] +``` + +### Options + +``` + -h, --help help for get-metro + --id string Metro 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 metros](equinix_metalv1_metros.md) - Manage metros resources + diff --git a/docs/equinix_metalv1_operating-systems.md b/docs/equinix_metalv1_operating-systems.md new file mode 100644 index 0000000..e761b70 --- /dev/null +++ b/docs/equinix_metalv1_operating-systems.md @@ -0,0 +1,28 @@ +## equinix metalv1 operating-systems + +Manage operating-systems resources + +### Synopsis + +Commands for managing operating-systems resources in the API + +### Options + +``` + -h, --help help for operating-systems +``` + +### 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 operating-systems find-operating-system-version](equinix_metalv1_operating-systems_find-operating-system-version.md) - Retrieve all operating system versions +* [equinix metalv1 operating-systems find-operating-systems](equinix_metalv1_operating-systems_find-operating-systems.md) - Retrieve all operating systems + diff --git a/docs/equinix_metalv1_operating-systems_find-operating-system-version.md b/docs/equinix_metalv1_operating-systems_find-operating-system-version.md new file mode 100644 index 0000000..6501372 --- /dev/null +++ b/docs/equinix_metalv1_operating-systems_find-operating-system-version.md @@ -0,0 +1,33 @@ +## equinix metalv1 operating-systems find-operating-system-version + +Retrieve all operating system versions + +### Synopsis + +Provides a listing of available operating system versions. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 operating-systems find-operating-system-version [flags] +``` + +### Options + +``` + -h, --help help for find-operating-system-version + --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 operating-systems](equinix_metalv1_operating-systems.md) - Manage operating-systems resources + diff --git a/docs/equinix_metalv1_operating-systems_find-operating-systems.md b/docs/equinix_metalv1_operating-systems_find-operating-systems.md new file mode 100644 index 0000000..007e2bf --- /dev/null +++ b/docs/equinix_metalv1_operating-systems_find-operating-systems.md @@ -0,0 +1,33 @@ +## equinix metalv1 operating-systems find-operating-systems + +Retrieve all operating systems + +### Synopsis + +Provides a listing of available operating systems to provision your new device with. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 operating-systems find-operating-systems [flags] +``` + +### Options + +``` + -h, --help help for find-operating-systems + --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 operating-systems](equinix_metalv1_operating-systems.md) - Manage operating-systems resources + diff --git a/docs/equinix_metalv1_organizations.md b/docs/equinix_metalv1_organizations.md new file mode 100644 index 0000000..77b9b9c --- /dev/null +++ b/docs/equinix_metalv1_organizations.md @@ -0,0 +1,41 @@ +## equinix metalv1 organizations + +Manage organizations resources + +### Synopsis + +Commands for managing organizations resources in the API + +### Options + +``` + -h, --help help for organizations +``` + +### 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 organizations create-organization](equinix_metalv1_organizations_create-organization.md) - Create an organization +* [equinix metalv1 organizations create-organization-invitation](equinix_metalv1_organizations_create-organization-invitation.md) - Create an invitation for an organization +* [equinix metalv1 organizations create-organization-project](equinix_metalv1_organizations_create-organization-project.md) - Create a project for the organization +* [equinix metalv1 organizations create-payment-method](equinix_metalv1_organizations_create-payment-method.md) - Create a payment method for the given organization +* [equinix metalv1 organizations delete-organization](equinix_metalv1_organizations_delete-organization.md) - Delete the organization +* [equinix metalv1 organizations find-operating-systems-by-organization](equinix_metalv1_organizations_find-operating-systems-by-organization.md) - Retrieve all operating systems visible by the organization +* [equinix metalv1 organizations find-organization-by-id](equinix_metalv1_organizations_find-organization-by-id.md) - Retrieve an organization's details +* [equinix metalv1 organizations find-organization-customdata](equinix_metalv1_organizations_find-organization-customdata.md) - Retrieve the custom metadata of an organization +* [equinix metalv1 organizations find-organization-invitations](equinix_metalv1_organizations_find-organization-invitations.md) - Retrieve organization invitations +* [equinix metalv1 organizations find-organization-payment-methods](equinix_metalv1_organizations_find-organization-payment-methods.md) - Retrieve all payment methods of an organization +* [equinix metalv1 organizations find-organization-projects](equinix_metalv1_organizations_find-organization-projects.md) - Retrieve all projects of an organization +* [equinix metalv1 organizations find-organization-transfers](equinix_metalv1_organizations_find-organization-transfers.md) - Retrieve all project transfer requests from or to an organization +* [equinix metalv1 organizations find-organizations](equinix_metalv1_organizations_find-organizations.md) - Retrieve all organizations +* [equinix metalv1 organizations find-plans-by-organization](equinix_metalv1_organizations_find-plans-by-organization.md) - Retrieve all plans visible by the organization +* [equinix metalv1 organizations update-organization](equinix_metalv1_organizations_update-organization.md) - Update the organization + diff --git a/docs/equinix_metalv1_organizations_create-organization-invitation.md b/docs/equinix_metalv1_organizations_create-organization-invitation.md new file mode 100644 index 0000000..723585c --- /dev/null +++ b/docs/equinix_metalv1_organizations_create-organization-invitation.md @@ -0,0 +1,41 @@ +## equinix metalv1 organizations create-organization-invitation + +Create an invitation for an organization + +### Synopsis + +In order to add a user to an organization, they must first be invited. To invite to several projects the parameter `projects_ids:[a,b,c]` can be used + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations create-organization-invitation [flags] +``` + +### Options + +``` + -h, --help help for create-organization-invitation + --id string Organization UUID (required) + --include string include field (JSON or string) + --invitation-input-additional-properties string invitation-input-additional-properties (JSON) + --invitation-input-invitee string invitation-input-invitee + --invitation-input-message string invitation-input-message + --invitation-input-organization_id string invitation-input-organization_id + --invitation-input-projects_ids string invitation-input-projects_ids (JSON array) + --invitation-input-roles string invitation-input-roles (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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_create-organization-project.md b/docs/equinix_metalv1_organizations_create-organization-project.md new file mode 100644 index 0000000..a731959 --- /dev/null +++ b/docs/equinix_metalv1_organizations_create-organization-project.md @@ -0,0 +1,42 @@ +## equinix metalv1 organizations create-organization-project + +Create a project for the organization + +### Synopsis + +Creates a new project for the organization + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations create-organization-project [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for create-organization-project + --id string Organization UUID (required) + --include string include field (JSON or string) + --project-create-input-additional-properties string project-create-input-additional-properties (JSON) + --project-create-input-customdata string project-create-input-customdata (JSON) + --project-create-input-name string The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis. + --project-create-input-payment_method_id string project-create-input-payment_method_id + --project-create-input-tags string project-create-input-tags (JSON array) + --project-create-input-type string project-create-input-type + --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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_create-organization.md b/docs/equinix_metalv1_organizations_create-organization.md new file mode 100644 index 0000000..dd951ea --- /dev/null +++ b/docs/equinix_metalv1_organizations_create-organization.md @@ -0,0 +1,57 @@ +## equinix metalv1 organizations create-organization + +Create an organization + +### Synopsis + +Creates an organization. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations create-organization [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for create-organization + --include string include field (JSON or string) + --organization-input-additional-properties string organization-input-additional-properties (JSON) + --organization-input-address-additional-properties string organization-input-address-additional-properties (JSON) + --organization-input-address-address string organization-input-address-address + --organization-input-address-address2 string organization-input-address-address2 + --organization-input-address-city string organization-input-address-city + --organization-input-address-coordinates string organization-input-address-coordinates (JSON) + --organization-input-address-country string organization-input-address-country + --organization-input-address-state string organization-input-address-state + --organization-input-address-zip_code string organization-input-address-zip_code + --organization-input-billing_address-additional-properties string organization-input-billing_address-additional-properties (JSON) + --organization-input-billing_address-address string organization-input-billing_address-address + --organization-input-billing_address-address2 string organization-input-billing_address-address2 + --organization-input-billing_address-city string organization-input-billing_address-city + --organization-input-billing_address-coordinates string organization-input-billing_address-coordinates (JSON) + --organization-input-billing_address-country string organization-input-billing_address-country + --organization-input-billing_address-state string organization-input-billing_address-state + --organization-input-billing_address-zip_code string organization-input-billing_address-zip_code + --organization-input-customdata string organization-input-customdata (JSON) + --organization-input-description string organization-input-description + --organization-input-name string organization-input-name + --organization-input-twitter string organization-input-twitter + --organization-input-website string organization-input-website + --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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_create-payment-method.md b/docs/equinix_metalv1_organizations_create-payment-method.md new file mode 100644 index 0000000..b392883 --- /dev/null +++ b/docs/equinix_metalv1_organizations_create-payment-method.md @@ -0,0 +1,39 @@ +## equinix metalv1 organizations create-payment-method + +Create a payment method for the given organization + +### Synopsis + +Creates a payment method. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations create-payment-method [flags] +``` + +### Options + +``` + -h, --help help for create-payment-method + --id string Organization UUID (required) + --include string include field (JSON or string) + --payment-method-create-input-additional-properties string payment-method-create-input-additional-properties (JSON) + --payment-method-create-input-default payment-method-create-input-default + --payment-method-create-input-name string payment-method-create-input-name + --payment-method-create-input-nonce string payment-method-create-input-nonce + --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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_delete-organization.md b/docs/equinix_metalv1_organizations_delete-organization.md new file mode 100644 index 0000000..65056bf --- /dev/null +++ b/docs/equinix_metalv1_organizations_delete-organization.md @@ -0,0 +1,34 @@ +## equinix metalv1 organizations delete-organization + +Delete the organization + +### Synopsis + +Deletes the organization. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations delete-organization [flags] +``` + +### Options + +``` + -h, --help help for delete-organization + --id string Organization 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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_find-operating-systems-by-organization.md b/docs/equinix_metalv1_organizations_find-operating-systems-by-organization.md new file mode 100644 index 0000000..be5b1b6 --- /dev/null +++ b/docs/equinix_metalv1_organizations_find-operating-systems-by-organization.md @@ -0,0 +1,35 @@ +## equinix metalv1 organizations find-operating-systems-by-organization + +Retrieve all operating systems visible by the organization + +### Synopsis + +Returns a listing of available operating systems for the given organization + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations find-operating-systems-by-organization [flags] +``` + +### Options + +``` + -h, --help help for find-operating-systems-by-organization + --id string Organization 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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_find-organization-by-id.md b/docs/equinix_metalv1_organizations_find-organization-by-id.md new file mode 100644 index 0000000..d501c5f --- /dev/null +++ b/docs/equinix_metalv1_organizations_find-organization-by-id.md @@ -0,0 +1,36 @@ +## equinix metalv1 organizations find-organization-by-id + +Retrieve an organization's details + +### Synopsis + +Returns a single organization's details, if the user is authorized to view it. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations find-organization-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-organization-by-id + --id string Organization 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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_find-organization-customdata.md b/docs/equinix_metalv1_organizations_find-organization-customdata.md new file mode 100644 index 0000000..ffe8f86 --- /dev/null +++ b/docs/equinix_metalv1_organizations_find-organization-customdata.md @@ -0,0 +1,34 @@ +## equinix metalv1 organizations find-organization-customdata + +Retrieve the custom metadata of an organization + +### Synopsis + +Provides the custom metadata stored for this organization in json format + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations find-organization-customdata [flags] +``` + +### Options + +``` + -h, --help help for find-organization-customdata + --id string Organization 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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_find-organization-invitations.md b/docs/equinix_metalv1_organizations_find-organization-invitations.md new file mode 100644 index 0000000..651433a --- /dev/null +++ b/docs/equinix_metalv1_organizations_find-organization-invitations.md @@ -0,0 +1,37 @@ +## equinix metalv1 organizations find-organization-invitations + +Retrieve organization invitations + +### Synopsis + +Returns all invitations in an organization. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations find-organization-invitations [flags] +``` + +### Options + +``` + -h, --help help for find-organization-invitations + --id string Organization UUID (required) + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_find-organization-payment-methods.md b/docs/equinix_metalv1_organizations_find-organization-payment-methods.md new file mode 100644 index 0000000..f856f6e --- /dev/null +++ b/docs/equinix_metalv1_organizations_find-organization-payment-methods.md @@ -0,0 +1,37 @@ +## equinix metalv1 organizations find-organization-payment-methods + +Retrieve all payment methods of an organization + +### Synopsis + +Returns all payment methods of an organization. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations find-organization-payment-methods [flags] +``` + +### Options + +``` + -h, --help help for find-organization-payment-methods + --id string Organization UUID (required) + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_find-organization-projects.md b/docs/equinix_metalv1_organizations_find-organization-projects.md new file mode 100644 index 0000000..f178d94 --- /dev/null +++ b/docs/equinix_metalv1_organizations_find-organization-projects.md @@ -0,0 +1,39 @@ +## equinix metalv1 organizations find-organization-projects + +Retrieve all projects of an organization + +### Synopsis + +Returns a collection of projects that belong to the organization. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations find-organization-projects [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-organization-projects + --id string Organization UUID (required) + --include string include field (JSON or string) + --name string name field + --page int page field + --per-page int per-page 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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_find-organization-transfers.md b/docs/equinix_metalv1_organizations_find-organization-transfers.md new file mode 100644 index 0000000..eaeee30 --- /dev/null +++ b/docs/equinix_metalv1_organizations_find-organization-transfers.md @@ -0,0 +1,35 @@ +## equinix metalv1 organizations find-organization-transfers + +Retrieve all project transfer requests from or to an organization + +### Synopsis + +Provides a collection of project transfer requests from or to the organization. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations find-organization-transfers [flags] +``` + +### Options + +``` + -h, --help help for find-organization-transfers + --id string Organization 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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_find-organizations.md b/docs/equinix_metalv1_organizations_find-organizations.md new file mode 100644 index 0000000..ef83d46 --- /dev/null +++ b/docs/equinix_metalv1_organizations_find-organizations.md @@ -0,0 +1,39 @@ +## equinix metalv1 organizations find-organizations + +Retrieve all organizations + +### Synopsis + +Returns a list of organizations that are accessible to the current user. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations find-organizations [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-organizations + --include string include field (JSON or string) + --page int page field + --per-page int per-page field + --personal string personal field + --request string JSON payload for additional optional fields not exposed as flags + --without-projects string without-projects 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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_find-plans-by-organization.md b/docs/equinix_metalv1_organizations_find-plans-by-organization.md new file mode 100644 index 0000000..36e7c81 --- /dev/null +++ b/docs/equinix_metalv1_organizations_find-plans-by-organization.md @@ -0,0 +1,36 @@ +## equinix metalv1 organizations find-plans-by-organization + +Retrieve all plans visible by the organization + +### Synopsis + +Returns a listing of available plans for the given organization + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations find-plans-by-organization [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-plans-by-organization + --id string Organization 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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_organizations_update-organization.md b/docs/equinix_metalv1_organizations_update-organization.md new file mode 100644 index 0000000..991b03c --- /dev/null +++ b/docs/equinix_metalv1_organizations_update-organization.md @@ -0,0 +1,58 @@ +## equinix metalv1 organizations update-organization + +Update the organization + +### Synopsis + +Updates the organization. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 organizations update-organization [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for update-organization + --id string Organization UUID (required) + --include string include field (JSON or string) + --organization-input-additional-properties string organization-input-additional-properties (JSON) + --organization-input-address-additional-properties string organization-input-address-additional-properties (JSON) + --organization-input-address-address string organization-input-address-address + --organization-input-address-address2 string organization-input-address-address2 + --organization-input-address-city string organization-input-address-city + --organization-input-address-coordinates string organization-input-address-coordinates (JSON) + --organization-input-address-country string organization-input-address-country + --organization-input-address-state string organization-input-address-state + --organization-input-address-zip_code string organization-input-address-zip_code + --organization-input-billing_address-additional-properties string organization-input-billing_address-additional-properties (JSON) + --organization-input-billing_address-address string organization-input-billing_address-address + --organization-input-billing_address-address2 string organization-input-billing_address-address2 + --organization-input-billing_address-city string organization-input-billing_address-city + --organization-input-billing_address-coordinates string organization-input-billing_address-coordinates (JSON) + --organization-input-billing_address-country string organization-input-billing_address-country + --organization-input-billing_address-state string organization-input-billing_address-state + --organization-input-billing_address-zip_code string organization-input-billing_address-zip_code + --organization-input-customdata string organization-input-customdata (JSON) + --organization-input-description string organization-input-description + --organization-input-name string organization-input-name + --organization-input-twitter string organization-input-twitter + --organization-input-website string organization-input-website + --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 organizations](equinix_metalv1_organizations.md) - Manage organizations resources + diff --git a/docs/equinix_metalv1_password-reset-tokens.md b/docs/equinix_metalv1_password-reset-tokens.md new file mode 100644 index 0000000..25021b5 --- /dev/null +++ b/docs/equinix_metalv1_password-reset-tokens.md @@ -0,0 +1,28 @@ +## equinix metalv1 password-reset-tokens + +Manage password-reset-tokens resources + +### Synopsis + +Commands for managing password-reset-tokens resources in the API + +### Options + +``` + -h, --help help for password-reset-tokens +``` + +### 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 password-reset-tokens create-password-reset-token](equinix_metalv1_password-reset-tokens_create-password-reset-token.md) - Create a password reset token +* [equinix metalv1 password-reset-tokens reset-password](equinix_metalv1_password-reset-tokens_reset-password.md) - Reset current user password + diff --git a/docs/equinix_metalv1_password-reset-tokens_create-password-reset-token.md b/docs/equinix_metalv1_password-reset-tokens_create-password-reset-token.md new file mode 100644 index 0000000..b9901d3 --- /dev/null +++ b/docs/equinix_metalv1_password-reset-tokens_create-password-reset-token.md @@ -0,0 +1,34 @@ +## equinix metalv1 password-reset-tokens create-password-reset-token + +Create a password reset token + +### Synopsis + +Creates a password reset token + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 password-reset-tokens create-password-reset-token [flags] +``` + +### Options + +``` + --email string email field + -h, --help help for create-password-reset-token + --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 password-reset-tokens](equinix_metalv1_password-reset-tokens.md) - Manage password-reset-tokens resources + diff --git a/docs/equinix_metalv1_password-reset-tokens_reset-password.md b/docs/equinix_metalv1_password-reset-tokens_reset-password.md new file mode 100644 index 0000000..2fa765e --- /dev/null +++ b/docs/equinix_metalv1_password-reset-tokens_reset-password.md @@ -0,0 +1,33 @@ +## equinix metalv1 password-reset-tokens reset-password + +Reset current user password + +### Synopsis + +Resets current user password. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 password-reset-tokens reset-password [flags] +``` + +### Options + +``` + -h, --help help for reset-password + --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 password-reset-tokens](equinix_metalv1_password-reset-tokens.md) - Manage password-reset-tokens resources + diff --git a/docs/equinix_metalv1_payment-methods.md b/docs/equinix_metalv1_payment-methods.md new file mode 100644 index 0000000..c83aa2b --- /dev/null +++ b/docs/equinix_metalv1_payment-methods.md @@ -0,0 +1,29 @@ +## equinix metalv1 payment-methods + +Manage payment-methods resources + +### Synopsis + +Commands for managing payment-methods resources in the API + +### Options + +``` + -h, --help help for payment-methods +``` + +### 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 payment-methods delete-payment-method](equinix_metalv1_payment-methods_delete-payment-method.md) - Delete the payment method +* [equinix metalv1 payment-methods find-payment-method-by-id](equinix_metalv1_payment-methods_find-payment-method-by-id.md) - Retrieve a payment method +* [equinix metalv1 payment-methods update-payment-method](equinix_metalv1_payment-methods_update-payment-method.md) - Update the payment method + diff --git a/docs/equinix_metalv1_payment-methods_delete-payment-method.md b/docs/equinix_metalv1_payment-methods_delete-payment-method.md new file mode 100644 index 0000000..41563e0 --- /dev/null +++ b/docs/equinix_metalv1_payment-methods_delete-payment-method.md @@ -0,0 +1,34 @@ +## equinix metalv1 payment-methods delete-payment-method + +Delete the payment method + +### Synopsis + +Deletes the payment method. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 payment-methods delete-payment-method [flags] +``` + +### Options + +``` + -h, --help help for delete-payment-method + --id string Payment Method 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 payment-methods](equinix_metalv1_payment-methods.md) - Manage payment-methods resources + diff --git a/docs/equinix_metalv1_payment-methods_find-payment-method-by-id.md b/docs/equinix_metalv1_payment-methods_find-payment-method-by-id.md new file mode 100644 index 0000000..26281cb --- /dev/null +++ b/docs/equinix_metalv1_payment-methods_find-payment-method-by-id.md @@ -0,0 +1,35 @@ +## equinix metalv1 payment-methods find-payment-method-by-id + +Retrieve a payment method + +### Synopsis + +Returns a payment method + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 payment-methods find-payment-method-by-id [flags] +``` + +### Options + +``` + -h, --help help for find-payment-method-by-id + --id string Payment Method 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 payment-methods](equinix_metalv1_payment-methods.md) - Manage payment-methods resources + diff --git a/docs/equinix_metalv1_payment-methods_update-payment-method.md b/docs/equinix_metalv1_payment-methods_update-payment-method.md new file mode 100644 index 0000000..6d95dc7 --- /dev/null +++ b/docs/equinix_metalv1_payment-methods_update-payment-method.md @@ -0,0 +1,42 @@ +## equinix metalv1 payment-methods update-payment-method + +Update the payment method + +### Synopsis + +Updates the payment method. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 payment-methods update-payment-method [flags] +``` + +### Options + +``` + -h, --help help for update-payment-method + --id string Payment Method UUID (required) + --include string include field (JSON or string) + --payment-method-update-input-additional-properties string payment-method-update-input-additional-properties (JSON) + --payment-method-update-input-billing_address string payment-method-update-input-billing_address (JSON) + --payment-method-update-input-cardholder_name string payment-method-update-input-cardholder_name + --payment-method-update-input-default payment-method-update-input-default + --payment-method-update-input-expiration_month string payment-method-update-input-expiration_month + --payment-method-update-input-expiration_year int payment-method-update-input-expiration_year + --payment-method-update-input-name string payment-method-update-input-name + --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 payment-methods](equinix_metalv1_payment-methods.md) - Manage payment-methods resources + diff --git a/docs/equinix_metalv1_plans.md b/docs/equinix_metalv1_plans.md new file mode 100644 index 0000000..df6a828 --- /dev/null +++ b/docs/equinix_metalv1_plans.md @@ -0,0 +1,28 @@ +## equinix metalv1 plans + +Manage plans resources + +### Synopsis + +Commands for managing plans resources in the API + +### Options + +``` + -h, --help help for plans +``` + +### 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 plans find-plans](equinix_metalv1_plans_find-plans.md) - Retrieve all plans +* [equinix metalv1 plans find-plans-by-project](equinix_metalv1_plans_find-plans-by-project.md) - Retrieve all plans visible by the project + diff --git a/docs/equinix_metalv1_plans_find-plans-by-project.md b/docs/equinix_metalv1_plans_find-plans-by-project.md new file mode 100644 index 0000000..ab19f4c --- /dev/null +++ b/docs/equinix_metalv1_plans_find-plans-by-project.md @@ -0,0 +1,36 @@ +## equinix metalv1 plans find-plans-by-project + +Retrieve all plans visible by the project + +### Synopsis + +Returns a listing of available plans for the given project + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 plans find-plans-by-project [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-plans-by-project + --id string Project 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 plans](equinix_metalv1_plans.md) - Manage plans resources + diff --git a/docs/equinix_metalv1_plans_find-plans.md b/docs/equinix_metalv1_plans_find-plans.md new file mode 100644 index 0000000..292d0c5 --- /dev/null +++ b/docs/equinix_metalv1_plans_find-plans.md @@ -0,0 +1,38 @@ +## equinix metalv1 plans find-plans + +Retrieve all plans + +### Synopsis + +Provides a listing of available plans to provision your device on. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 plans find-plans [flags] +``` + +### Options + +``` + --categories string categories field (JSON or string) + --exclude string exclude field (JSON or string) + -h, --help help for find-plans + --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 +``` + +### 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 plans](equinix_metalv1_plans.md) - Manage plans resources + diff --git a/docs/equinix_metalv1_ports.md b/docs/equinix_metalv1_ports.md new file mode 100644 index 0000000..3e09033 --- /dev/null +++ b/docs/equinix_metalv1_ports.md @@ -0,0 +1,40 @@ +## equinix metalv1 ports + +Manage ports resources + +### Synopsis + +Commands for managing ports resources in the API + +### Options + +``` + -h, --help help for ports +``` + +### 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 ports assign-native-vlan](equinix_metalv1_ports_assign-native-vlan.md) - Assign a native VLAN +* [equinix metalv1 ports assign-port](equinix_metalv1_ports_assign-port.md) - Assign a port to virtual network +* [equinix metalv1 ports bond-port](equinix_metalv1_ports_bond-port.md) - Enabling bonding +* [equinix metalv1 ports convert-layer2](equinix_metalv1_ports_convert-layer2.md) - Convert to Layer 2 +* [equinix metalv1 ports convert-layer3](equinix_metalv1_ports_convert-layer3.md) - Convert to Layer 3 +* [equinix metalv1 ports create-port-vlan-assignment-batch](equinix_metalv1_ports_create-port-vlan-assignment-batch.md) - Create a new Port-VLAN Assignment management batch +* [equinix metalv1 ports delete-native-vlan](equinix_metalv1_ports_delete-native-vlan.md) - Remove native VLAN +* [equinix metalv1 ports disbond-port](equinix_metalv1_ports_disbond-port.md) - Disabling bonding +* [equinix metalv1 ports find-port-by-id](equinix_metalv1_ports_find-port-by-id.md) - Retrieve a port +* [equinix metalv1 ports find-port-vlan-assignment-batch-by-port-id-and-batch-id](equinix_metalv1_ports_find-port-vlan-assignment-batch-by-port-id-and-batch-id.md) - Retrieve a VLAN Assignment Batch's details +* [equinix metalv1 ports find-port-vlan-assignment-batches](equinix_metalv1_ports_find-port-vlan-assignment-batches.md) - List the VLAN Assignment Batches for a port +* [equinix metalv1 ports find-port-vlan-assignment-by-port-id-and-assignment-id](equinix_metalv1_ports_find-port-vlan-assignment-by-port-id-and-assignment-id.md) - Show a particular Port VLAN assignment's details +* [equinix metalv1 ports find-port-vlan-assignments](equinix_metalv1_ports_find-port-vlan-assignments.md) - List Current VLAN assignments for a port +* [equinix metalv1 ports unassign-port](equinix_metalv1_ports_unassign-port.md) - Unassign a port + diff --git a/docs/equinix_metalv1_ports_assign-native-vlan.md b/docs/equinix_metalv1_ports_assign-native-vlan.md new file mode 100644 index 0000000..346d1c6 --- /dev/null +++ b/docs/equinix_metalv1_ports_assign-native-vlan.md @@ -0,0 +1,36 @@ +## equinix metalv1 ports assign-native-vlan + +Assign a native VLAN + +### Synopsis + +Sets a virtual network on this port as a "native VLAN". The VLAN must have already been assigned using the using the "Assign a port to a virtual network" operation. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports assign-native-vlan [flags] +``` + +### Options + +``` + -h, --help help for assign-native-vlan + --id string Port UUID (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --vnid string vnid 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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_assign-port.md b/docs/equinix_metalv1_ports_assign-port.md new file mode 100644 index 0000000..bcf78e8 --- /dev/null +++ b/docs/equinix_metalv1_ports_assign-port.md @@ -0,0 +1,37 @@ +## equinix metalv1 ports assign-port + +Assign a port to virtual network + +### Synopsis + +Assign a hardware port to a virtual network. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports assign-port [flags] +``` + +### Options + +``` + -h, --help help for assign-port + --id string Port UUID (required) + --include string include field (JSON or string) + --port-assign-input-additional-properties string port-assign-input-additional-properties (JSON) + --port-assign-input-vnid string Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself. + --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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_bond-port.md b/docs/equinix_metalv1_ports_bond-port.md new file mode 100644 index 0000000..dd3756e --- /dev/null +++ b/docs/equinix_metalv1_ports_bond-port.md @@ -0,0 +1,36 @@ +## equinix metalv1 ports bond-port + +Enabling bonding + +### Synopsis + +Enabling bonding for one or all ports + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports bond-port [flags] +``` + +### Options + +``` + --bulk-enable bulk-enable field + -h, --help help for bond-port + --id string Port 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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_convert-layer2.md b/docs/equinix_metalv1_ports_convert-layer2.md new file mode 100644 index 0000000..d122183 --- /dev/null +++ b/docs/equinix_metalv1_ports_convert-layer2.md @@ -0,0 +1,37 @@ +## equinix metalv1 ports convert-layer2 + +Convert to Layer 2 + +### Synopsis + +Converts a bond port to Layer 2. IP assignments of the port will be removed. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports convert-layer2 [flags] +``` + +### Options + +``` + -h, --help help for convert-layer2 + --id string Port UUID (required) + --include string include field (JSON or string) + --port-assign-input-additional-properties string port-assign-input-additional-properties (JSON) + --port-assign-input-vnid string Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself. + --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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_convert-layer3.md b/docs/equinix_metalv1_ports_convert-layer3.md new file mode 100644 index 0000000..fe3df1b --- /dev/null +++ b/docs/equinix_metalv1_ports_convert-layer3.md @@ -0,0 +1,37 @@ +## equinix metalv1 ports convert-layer3 + +Convert to Layer 3 + +### Synopsis + +Converts a bond port to Layer 3. VLANs must first be unassigned. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports convert-layer3 [flags] +``` + +### Options + +``` + -h, --help help for convert-layer3 + --id string Port UUID (required) + --include string include field (JSON or string) + --port-convert-layer3-input-additional-properties string port-convert-layer3-input-additional-properties (JSON) + --port-convert-layer3-input-request_ips string port-convert-layer3-input-request_ips (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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_create-port-vlan-assignment-batch.md b/docs/equinix_metalv1_ports_create-port-vlan-assignment-batch.md new file mode 100644 index 0000000..3c76e38 --- /dev/null +++ b/docs/equinix_metalv1_ports_create-port-vlan-assignment-batch.md @@ -0,0 +1,37 @@ +## equinix metalv1 ports create-port-vlan-assignment-batch + +Create a new Port-VLAN Assignment management batch + +### Synopsis + +Create a new asynchronous batch request which handles adding and/or removing the VLANs to which the port is assigned. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports create-port-vlan-assignment-batch [flags] +``` + +### Options + +``` + -h, --help help for create-port-vlan-assignment-batch + --id string Port UUID (required) + --include string include field (JSON or string) + --port-vlan-assignment-batch-create-input-additional-properties string port-vlan-assignment-batch-create-input-additional-properties (JSON) + --port-vlan-assignment-batch-create-input-vlan_assignments string port-vlan-assignment-batch-create-input-vlan_assignments (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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_delete-native-vlan.md b/docs/equinix_metalv1_ports_delete-native-vlan.md new file mode 100644 index 0000000..324d3e2 --- /dev/null +++ b/docs/equinix_metalv1_ports_delete-native-vlan.md @@ -0,0 +1,35 @@ +## equinix metalv1 ports delete-native-vlan + +Remove native VLAN + +### Synopsis + +Removes the native VLAN from this port + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports delete-native-vlan [flags] +``` + +### Options + +``` + -h, --help help for delete-native-vlan + --id string Port 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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_disbond-port.md b/docs/equinix_metalv1_ports_disbond-port.md new file mode 100644 index 0000000..c50077a --- /dev/null +++ b/docs/equinix_metalv1_ports_disbond-port.md @@ -0,0 +1,36 @@ +## equinix metalv1 ports disbond-port + +Disabling bonding + +### Synopsis + +Disabling bonding for one or all ports + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports disbond-port [flags] +``` + +### Options + +``` + --bulk-disable bulk-disable field + -h, --help help for disbond-port + --id string Port 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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_find-port-by-id.md b/docs/equinix_metalv1_ports_find-port-by-id.md new file mode 100644 index 0000000..ca3d8db --- /dev/null +++ b/docs/equinix_metalv1_ports_find-port-by-id.md @@ -0,0 +1,35 @@ +## equinix metalv1 ports find-port-by-id + +Retrieve a port + +### Synopsis + +Returns a port + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports find-port-by-id [flags] +``` + +### Options + +``` + -h, --help help for find-port-by-id + --id string Port 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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_find-port-vlan-assignment-batch-by-port-id-and-batch-id.md b/docs/equinix_metalv1_ports_find-port-vlan-assignment-batch-by-port-id-and-batch-id.md new file mode 100644 index 0000000..5676381 --- /dev/null +++ b/docs/equinix_metalv1_ports_find-port-vlan-assignment-batch-by-port-id-and-batch-id.md @@ -0,0 +1,36 @@ +## equinix metalv1 ports find-port-vlan-assignment-batch-by-port-id-and-batch-id + +Retrieve a VLAN Assignment Batch's details + +### Synopsis + +Returns the details of an existing Port-VLAN Assignment batch, including the list of VLANs to assign or unassign, and the current state of the batch. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports find-port-vlan-assignment-batch-by-port-id-and-batch-id [flags] +``` + +### Options + +``` + --batch-id string Batch ID (required) + -h, --help help for find-port-vlan-assignment-batch-by-port-id-and-batch-id + --id string Port 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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_find-port-vlan-assignment-batches.md b/docs/equinix_metalv1_ports_find-port-vlan-assignment-batches.md new file mode 100644 index 0000000..8fc1021 --- /dev/null +++ b/docs/equinix_metalv1_ports_find-port-vlan-assignment-batches.md @@ -0,0 +1,34 @@ +## equinix metalv1 ports find-port-vlan-assignment-batches + +List the VLAN Assignment Batches for a port + +### Synopsis + +Show all the VLAN assignment batches that have been created for managing this port's VLAN assignments + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports find-port-vlan-assignment-batches [flags] +``` + +### Options + +``` + -h, --help help for find-port-vlan-assignment-batches + --id string Port 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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_find-port-vlan-assignment-by-port-id-and-assignment-id.md b/docs/equinix_metalv1_ports_find-port-vlan-assignment-by-port-id-and-assignment-id.md new file mode 100644 index 0000000..055b079 --- /dev/null +++ b/docs/equinix_metalv1_ports_find-port-vlan-assignment-by-port-id-and-assignment-id.md @@ -0,0 +1,36 @@ +## equinix metalv1 ports find-port-vlan-assignment-by-port-id-and-assignment-id + +Show a particular Port VLAN assignment's details + +### Synopsis + +Show the details of a specific Port-VLAN assignment, including the current state and if the VLAN is set as native. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports find-port-vlan-assignment-by-port-id-and-assignment-id [flags] +``` + +### Options + +``` + --assignment-id string Assignment ID (required) + -h, --help help for find-port-vlan-assignment-by-port-id-and-assignment-id + --id string Port 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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_find-port-vlan-assignments.md b/docs/equinix_metalv1_ports_find-port-vlan-assignments.md new file mode 100644 index 0000000..9f31c15 --- /dev/null +++ b/docs/equinix_metalv1_ports_find-port-vlan-assignments.md @@ -0,0 +1,35 @@ +## equinix metalv1 ports find-port-vlan-assignments + +List Current VLAN assignments for a port + +### Synopsis + +Show the port's current VLAN assignments, including if this VLAN is set as native, and the current state of the assignment (ex. 'assigned' or 'unassigning') + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports find-port-vlan-assignments [flags] +``` + +### Options + +``` + -h, --help help for find-port-vlan-assignments + --id string Port 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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_ports_unassign-port.md b/docs/equinix_metalv1_ports_unassign-port.md new file mode 100644 index 0000000..cf63620 --- /dev/null +++ b/docs/equinix_metalv1_ports_unassign-port.md @@ -0,0 +1,37 @@ +## equinix metalv1 ports unassign-port + +Unassign a port + +### Synopsis + +Unassign a port for a hardware. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 ports unassign-port [flags] +``` + +### Options + +``` + -h, --help help for unassign-port + --id string Port UUID (required) + --include string include field (JSON or string) + --port-assign-input-additional-properties string port-assign-input-additional-properties (JSON) + --port-assign-input-vnid string Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself. + --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 ports](equinix_metalv1_ports.md) - Manage ports resources + diff --git a/docs/equinix_metalv1_projects.md b/docs/equinix_metalv1_projects.md new file mode 100644 index 0000000..bc82016 --- /dev/null +++ b/docs/equinix_metalv1_projects.md @@ -0,0 +1,37 @@ +## equinix metalv1 projects + +Manage projects resources + +### Synopsis + +Commands for managing projects resources in the API + +### Options + +``` + -h, --help help for projects +``` + +### 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 projects create-project](equinix_metalv1_projects_create-project.md) - Create a project +* [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-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 +* [equinix metalv1 projects find-project-memberships](equinix_metalv1_projects_find-project-memberships.md) - Retrieve project memberships +* [equinix metalv1 projects find-projects](equinix_metalv1_projects_find-projects.md) - Retrieve all projects +* [equinix metalv1 projects update-project](equinix_metalv1_projects_update-project.md) - Update the project + diff --git a/docs/equinix_metalv1_projects_create-project-invitation.md b/docs/equinix_metalv1_projects_create-project-invitation.md new file mode 100644 index 0000000..309cecf --- /dev/null +++ b/docs/equinix_metalv1_projects_create-project-invitation.md @@ -0,0 +1,41 @@ +## equinix metalv1 projects create-project-invitation + +Create an invitation for a project + +### Synopsis + +In order to add a user to a project, they must first be invited. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 projects create-project-invitation [flags] +``` + +### Options + +``` + -h, --help help for create-project-invitation + --include string include field (JSON or string) + --invitation-input-additional-properties string invitation-input-additional-properties (JSON) + --invitation-input-invitee string invitation-input-invitee + --invitation-input-message string invitation-input-message + --invitation-input-organization_id string invitation-input-organization_id + --invitation-input-projects_ids string invitation-input-projects_ids (JSON array) + --invitation-input-roles string invitation-input-roles (JSON array) + --project-id string Project 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 projects](equinix_metalv1_projects.md) - Manage projects resources + diff --git a/docs/equinix_metalv1_projects_create-project.md b/docs/equinix_metalv1_projects_create-project.md new file mode 100644 index 0000000..f356df0 --- /dev/null +++ b/docs/equinix_metalv1_projects_create-project.md @@ -0,0 +1,42 @@ +## equinix metalv1 projects create-project + +Create a project + +### Synopsis + +Creates a new project for the user's default organization. If the user does not have a default organization, the API will look for a personal organization belonging to the user with the name "{User's Full Name} Projects" to associate the project with. If that organization does not exist a new organization named "{User's Full Name} Projects" will be created and the new project will be tied to that organization. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 projects create-project [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for create-project + --include string include field (JSON or string) + --project-create-from-root-input-additional-properties string project-create-from-root-input-additional-properties (JSON) + --project-create-from-root-input-customdata string project-create-from-root-input-customdata (JSON) + --project-create-from-root-input-name string The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis. + --project-create-from-root-input-organization_id string project-create-from-root-input-organization_id + --project-create-from-root-input-payment_method_id string project-create-from-root-input-payment_method_id + --project-create-from-root-input-tags string project-create-from-root-input-tags (JSON array) + --project-create-from-root-input-type string project-create-from-root-input-type + --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 projects](equinix_metalv1_projects.md) - Manage projects resources + diff --git a/docs/equinix_metalv1_projects_create-transfer-request.md b/docs/equinix_metalv1_projects_create-transfer-request.md new file mode 100644 index 0000000..7898470 --- /dev/null +++ b/docs/equinix_metalv1_projects_create-transfer-request.md @@ -0,0 +1,37 @@ +## equinix metalv1 projects create-transfer-request + +Create a transfer request + +### Synopsis + +Organization owners can transfer their projects to other organizations. Deprecated + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 projects create-transfer-request [flags] +``` + +### Options + +``` + -h, --help help for create-transfer-request + --id string UUID of the project to be transferred (required) + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --transfer-request-input-additional-properties string transfer-request-input-additional-properties (JSON) + --transfer-request-input-target_organization_id string transfer-request-input-target_organization_id +``` + +### 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 projects](equinix_metalv1_projects.md) - Manage projects resources + diff --git a/docs/equinix_metalv1_projects_delete-project.md b/docs/equinix_metalv1_projects_delete-project.md new file mode 100644 index 0000000..f004821 --- /dev/null +++ b/docs/equinix_metalv1_projects_delete-project.md @@ -0,0 +1,34 @@ +## equinix metalv1 projects delete-project + +Delete the project + +### Synopsis + +Deletes the project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 projects delete-project [flags] +``` + +### Options + +``` + -h, --help help for delete-project + --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 projects](equinix_metalv1_projects.md) - Manage projects resources + diff --git a/docs/equinix_metalv1_projects_find-i-p-reservation-customdata.md b/docs/equinix_metalv1_projects_find-i-p-reservation-customdata.md new file mode 100644 index 0000000..05a85ef --- /dev/null +++ b/docs/equinix_metalv1_projects_find-i-p-reservation-customdata.md @@ -0,0 +1,35 @@ +## equinix metalv1 projects find-i-p-reservation-customdata + +Retrieve the custom metadata of an IP Reservation + +### Synopsis + +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] +``` + +### Options + +``` + -h, --help help for find-i-p-reservation-customdata + --id string Ip Reservation UUID (required) + --project-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 projects](equinix_metalv1_projects.md) - Manage projects resources + diff --git a/docs/equinix_metalv1_projects_find-project-by-id.md b/docs/equinix_metalv1_projects_find-project-by-id.md new file mode 100644 index 0000000..15642fd --- /dev/null +++ b/docs/equinix_metalv1_projects_find-project-by-id.md @@ -0,0 +1,36 @@ +## equinix metalv1 projects find-project-by-id + +Retrieve a project + +### Synopsis + +Returns a single project if the user has access + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 projects find-project-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-project-by-id + --id string Project 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 projects](equinix_metalv1_projects.md) - Manage projects resources + diff --git a/docs/equinix_metalv1_projects_find-project-customdata.md b/docs/equinix_metalv1_projects_find-project-customdata.md new file mode 100644 index 0000000..9d95102 --- /dev/null +++ b/docs/equinix_metalv1_projects_find-project-customdata.md @@ -0,0 +1,34 @@ +## equinix metalv1 projects find-project-customdata + +Retrieve the custom metadata of a project + +### Synopsis + +Provides the custom metadata stored for this project in json format + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 projects find-project-customdata [flags] +``` + +### Options + +``` + -h, --help help for find-project-customdata + --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 projects](equinix_metalv1_projects.md) - Manage projects resources + diff --git a/docs/equinix_metalv1_projects_find-project-invitations.md b/docs/equinix_metalv1_projects_find-project-invitations.md new file mode 100644 index 0000000..8651df7 --- /dev/null +++ b/docs/equinix_metalv1_projects_find-project-invitations.md @@ -0,0 +1,37 @@ +## equinix metalv1 projects find-project-invitations + +Retrieve project invitations + +### Synopsis + +Returns all invitations in a project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 projects find-project-invitations [flags] +``` + +### Options + +``` + -h, --help help for find-project-invitations + --include string include field (JSON or string) + --page int page field + --per-page int per-page field + --project-id string Project 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 projects](equinix_metalv1_projects.md) - Manage projects resources + diff --git a/docs/equinix_metalv1_projects_find-project-memberships.md b/docs/equinix_metalv1_projects_find-project-memberships.md new file mode 100644 index 0000000..a2f8b9e --- /dev/null +++ b/docs/equinix_metalv1_projects_find-project-memberships.md @@ -0,0 +1,38 @@ +## equinix metalv1 projects find-project-memberships + +Retrieve project memberships + +### Synopsis + +Returns all memberships in a project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 projects find-project-memberships [flags] +``` + +### Options + +``` + -h, --help help for find-project-memberships + --include string include field (JSON or string) + --page int page field + --per-page int per-page field + --project-id string Project UUID (required) + --request string JSON payload for additional optional fields not exposed as flags + --search string search 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 projects](equinix_metalv1_projects.md) - Manage projects resources + diff --git a/docs/equinix_metalv1_projects_find-projects.md b/docs/equinix_metalv1_projects_find-projects.md new file mode 100644 index 0000000..1c0fb6a --- /dev/null +++ b/docs/equinix_metalv1_projects_find-projects.md @@ -0,0 +1,38 @@ +## equinix metalv1 projects find-projects + +Retrieve all projects + +### Synopsis + +Returns a collection of projects that the current user is a member of. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 projects find-projects [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-projects + --include string include field (JSON or string) + --name string name field + --page int page field + --per-page int per-page 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 projects](equinix_metalv1_projects.md) - Manage projects resources + diff --git a/docs/equinix_metalv1_projects_update-project.md b/docs/equinix_metalv1_projects_update-project.md new file mode 100644 index 0000000..f0c225f --- /dev/null +++ b/docs/equinix_metalv1_projects_update-project.md @@ -0,0 +1,42 @@ +## equinix metalv1 projects update-project + +Update the project + +### Synopsis + +Updates the project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 projects update-project [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for update-project + --id string Project UUID (required) + --include string include field (JSON or string) + --project-update-input-additional-properties string project-update-input-additional-properties (JSON) + --project-update-input-backend_transfer_enabled project-update-input-backend_transfer_enabled + --project-update-input-customdata string project-update-input-customdata (JSON) + --project-update-input-name string The name of the project. Cannot contain characters encoded in greater than 3 bytes such as emojis. + --project-update-input-payment_method_id string project-update-input-payment_method_id + --project-update-input-tags string project-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 projects](equinix_metalv1_projects.md) - Manage projects resources + diff --git a/docs/equinix_metalv1_s-s-h-keys.md b/docs/equinix_metalv1_s-s-h-keys.md new file mode 100644 index 0000000..f766d6b --- /dev/null +++ b/docs/equinix_metalv1_s-s-h-keys.md @@ -0,0 +1,34 @@ +## 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 new file mode 100644 index 0000000..7ebafdd --- /dev/null +++ b/docs/equinix_metalv1_s-s-h-keys_create-project-s-s-h-key.md @@ -0,0 +1,43 @@ +## 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 new file mode 100644 index 0000000..2b47df4 --- /dev/null +++ b/docs/equinix_metalv1_s-s-h-keys_create-s-s-h-key.md @@ -0,0 +1,42 @@ +## 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 new file mode 100644 index 0000000..dabdbb7 --- /dev/null +++ b/docs/equinix_metalv1_s-s-h-keys_delete-s-s-h-key.md @@ -0,0 +1,37 @@ +## 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 new file mode 100644 index 0000000..2093000 --- /dev/null +++ b/docs/equinix_metalv1_s-s-h-keys_find-device-s-s-h-keys.md @@ -0,0 +1,39 @@ +## 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 new file mode 100644 index 0000000..354d9b0 --- /dev/null +++ b/docs/equinix_metalv1_s-s-h-keys_find-project-s-s-h-keys.md @@ -0,0 +1,39 @@ +## 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 new file mode 100644 index 0000000..4911ffc --- /dev/null +++ b/docs/equinix_metalv1_s-s-h-keys_find-s-s-h-key-by-id.md @@ -0,0 +1,38 @@ +## 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_find-s-s-h-keys.md b/docs/equinix_metalv1_s-s-h-keys_find-s-s-h-keys.md new file mode 100644 index 0000000..f216ded --- /dev/null +++ b/docs/equinix_metalv1_s-s-h-keys_find-s-s-h-keys.md @@ -0,0 +1,38 @@ +## equinix metalv1 s-s-h-keys find-s-s-h-keys + +Execute find-s-s-h-keys operation + +### Synopsis + +Execute the find-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-s-s-h-keys [flags] +``` + +### Options + +``` + -h, --help help for find-s-s-h-keys + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --search string search 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_update-s-s-h-key.md b/docs/equinix_metalv1_s-s-h-keys_update-s-s-h-key.md new file mode 100644 index 0000000..2df6a23 --- /dev/null +++ b/docs/equinix_metalv1_s-s-h-keys_update-s-s-h-key.md @@ -0,0 +1,42 @@ +## 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_self-service-reservations.md b/docs/equinix_metalv1_self-service-reservations.md new file mode 100644 index 0000000..de08a44 --- /dev/null +++ b/docs/equinix_metalv1_self-service-reservations.md @@ -0,0 +1,29 @@ +## equinix metalv1 self-service-reservations + +Manage self-service-reservations resources + +### Synopsis + +Commands for managing self-service-reservations resources in the API + +### Options + +``` + -h, --help help for self-service-reservations +``` + +### 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 self-service-reservations create-self-service-reservation](equinix_metalv1_self-service-reservations_create-self-service-reservation.md) - Create a reservation +* [equinix metalv1 self-service-reservations find-self-service-reservation](equinix_metalv1_self-service-reservations_find-self-service-reservation.md) - Retrieve a reservation +* [equinix metalv1 self-service-reservations find-self-service-reservations](equinix_metalv1_self-service-reservations_find-self-service-reservations.md) - Retrieve all reservations + diff --git a/docs/equinix_metalv1_self-service-reservations_create-self-service-reservation.md b/docs/equinix_metalv1_self-service-reservations_create-self-service-reservation.md new file mode 100644 index 0000000..5d0e9bd --- /dev/null +++ b/docs/equinix_metalv1_self-service-reservations_create-self-service-reservation.md @@ -0,0 +1,40 @@ +## equinix metalv1 self-service-reservations create-self-service-reservation + +Create a reservation + +### Synopsis + +Creates a reservation. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 self-service-reservations create-self-service-reservation [flags] +``` + +### Options + +``` + --create-self-service-reservation-request-additional-properties string create-self-service-reservation-request-additional-properties (JSON) + --create-self-service-reservation-request-item string create-self-service-reservation-request-item (JSON array) + --create-self-service-reservation-request-notes string create-self-service-reservation-request-notes + --create-self-service-reservation-request-period-additional-properties string create-self-service-reservation-request-period-additional-properties (JSON) + --create-self-service-reservation-request-period-count int create-self-service-reservation-request-period-count + --create-self-service-reservation-request-period-unit string create-self-service-reservation-request-period-unit + -h, --help help for create-self-service-reservation + --project-id string Project 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 self-service-reservations](equinix_metalv1_self-service-reservations.md) - Manage self-service-reservations resources + diff --git a/docs/equinix_metalv1_self-service-reservations_find-self-service-reservation.md b/docs/equinix_metalv1_self-service-reservations_find-self-service-reservation.md new file mode 100644 index 0000000..310c884 --- /dev/null +++ b/docs/equinix_metalv1_self-service-reservations_find-self-service-reservation.md @@ -0,0 +1,35 @@ +## equinix metalv1 self-service-reservations find-self-service-reservation + +Retrieve a reservation + +### Synopsis + +Returns a reservation + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 self-service-reservations find-self-service-reservation [flags] +``` + +### Options + +``` + -h, --help help for find-self-service-reservation + --id string Reservation short_id (required) + --project-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 self-service-reservations](equinix_metalv1_self-service-reservations.md) - Manage self-service-reservations resources + diff --git a/docs/equinix_metalv1_self-service-reservations_find-self-service-reservations.md b/docs/equinix_metalv1_self-service-reservations_find-self-service-reservations.md new file mode 100644 index 0000000..55cab00 --- /dev/null +++ b/docs/equinix_metalv1_self-service-reservations_find-self-service-reservations.md @@ -0,0 +1,37 @@ +## equinix metalv1 self-service-reservations find-self-service-reservations + +Retrieve all reservations + +### Synopsis + +Returns all reservations. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 self-service-reservations find-self-service-reservations [flags] +``` + +### Options + +``` + --categories string categories field (JSON or string) + -h, --help help for find-self-service-reservations + --page int page field + --per-page int per-page field + --project-id string Project 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 self-service-reservations](equinix_metalv1_self-service-reservations.md) - Manage self-service-reservations resources + diff --git a/docs/equinix_metalv1_spot-market.md b/docs/equinix_metalv1_spot-market.md new file mode 100644 index 0000000..0ab18fc --- /dev/null +++ b/docs/equinix_metalv1_spot-market.md @@ -0,0 +1,33 @@ +## equinix metalv1 spot-market + +Manage spot-market resources + +### Synopsis + +Commands for managing spot-market resources in the API + +### Options + +``` + -h, --help help for spot-market +``` + +### 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 spot-market create-spot-market-request](equinix_metalv1_spot-market_create-spot-market-request.md) - Create a spot market request +* [equinix metalv1 spot-market delete-spot-market-request](equinix_metalv1_spot-market_delete-spot-market-request.md) - Delete the spot market request +* [equinix metalv1 spot-market find-metro-spot-market-prices](equinix_metalv1_spot-market_find-metro-spot-market-prices.md) - Get current spot market prices for metros +* [equinix metalv1 spot-market find-spot-market-prices](equinix_metalv1_spot-market_find-spot-market-prices.md) - Get current spot market prices +* [equinix metalv1 spot-market find-spot-market-prices-history](equinix_metalv1_spot-market_find-spot-market-prices-history.md) - Get spot market prices for a given period of time +* [equinix metalv1 spot-market find-spot-market-request-by-id](equinix_metalv1_spot-market_find-spot-market-request-by-id.md) - Retrieve a spot market request +* [equinix metalv1 spot-market list-spot-market-requests](equinix_metalv1_spot-market_list-spot-market-requests.md) - List spot market requests + diff --git a/docs/equinix_metalv1_spot-market_create-spot-market-request.md b/docs/equinix_metalv1_spot-market_create-spot-market-request.md new file mode 100644 index 0000000..a95eca6 --- /dev/null +++ b/docs/equinix_metalv1_spot-market_create-spot-market-request.md @@ -0,0 +1,59 @@ +## equinix metalv1 spot-market create-spot-market-request + +Create a spot market request + +### Synopsis + +Creates a new spot market request. Type-specific options (such as operating_system for baremetal devices) should be included in the main data structure alongside hostname and plan. The features attribute allows you to optionally specify what features your server should have. For example, if you require a server with a TPM chip, you may specify `{ "features": { "tpm": "required" } }` (or `{ "features": ["tpm"] }` in shorthand). The request will fail if there are no available servers matching your criteria. Alternatively, if you do not require a certain feature, but would prefer to be assigned a server with that feature if there are any available, you may specify that feature with a preferred value (see the example request below). The request will not fail if we have no servers with that feature in our inventory. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 spot-market create-spot-market-request [flags] +``` + +### Options + +``` + -h, --help help for create-spot-market-request + --id string Project UUID (required) + --request string JSON payload for additional optional fields not exposed as flags + --spot-market-request-create-input-additional-properties string spot-market-request-create-input-additional-properties (JSON) + --spot-market-request-create-input-devices_max int spot-market-request-create-input-devices_max + --spot-market-request-create-input-devices_min int spot-market-request-create-input-devices_min + --spot-market-request-create-input-facilities string Deprecated (JSON array) + --spot-market-request-create-input-instance_parameters-additional-properties string spot-market-request-create-input-instance_parameters-additional-properties (JSON) + --spot-market-request-create-input-instance_parameters-always_pxe spot-market-request-create-input-instance_parameters-always_pxe + --spot-market-request-create-input-instance_parameters-billing_cycle string spot-market-request-create-input-instance_parameters-billing_cycle + --spot-market-request-create-input-instance_parameters-customdata string spot-market-request-create-input-instance_parameters-customdata (JSON) + --spot-market-request-create-input-instance_parameters-description string spot-market-request-create-input-instance_parameters-description + --spot-market-request-create-input-instance_parameters-features string spot-market-request-create-input-instance_parameters-features (JSON array) + --spot-market-request-create-input-instance_parameters-hostname string spot-market-request-create-input-instance_parameters-hostname + --spot-market-request-create-input-instance_parameters-hostnames string spot-market-request-create-input-instance_parameters-hostnames (JSON array) + --spot-market-request-create-input-instance_parameters-locked Whether the device should be locked, preventing accidental deletion. + --spot-market-request-create-input-instance_parameters-no_ssh_keys spot-market-request-create-input-instance_parameters-no_ssh_keys + --spot-market-request-create-input-instance_parameters-operating_system string spot-market-request-create-input-instance_parameters-operating_system + --spot-market-request-create-input-instance_parameters-plan string spot-market-request-create-input-instance_parameters-plan + --spot-market-request-create-input-instance_parameters-private_ipv4_subnet_size int spot-market-request-create-input-instance_parameters-private_ipv4_subnet_size + --spot-market-request-create-input-instance_parameters-project_ssh_keys string spot-market-request-create-input-instance_parameters-project_ssh_keys (JSON array) + --spot-market-request-create-input-instance_parameters-public_ipv4_subnet_size int spot-market-request-create-input-instance_parameters-public_ipv4_subnet_size + --spot-market-request-create-input-instance_parameters-tags string spot-market-request-create-input-instance_parameters-tags (JSON array) + --spot-market-request-create-input-instance_parameters-termination_time string spot-market-request-create-input-instance_parameters-termination_time (JSON) + --spot-market-request-create-input-instance_parameters-user_ssh_keys string The UUIDs of users whose SSH keys should be included on the provisioned device. (JSON array) + --spot-market-request-create-input-instance_parameters-userdata string spot-market-request-create-input-instance_parameters-userdata + --spot-market-request-create-input-max_bid_price float spot-market-request-create-input-max_bid_price + --spot-market-request-create-input-metro string The metro ID or code the spot market request will be created in. +``` + +### 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 spot-market](equinix_metalv1_spot-market.md) - Manage spot-market resources + diff --git a/docs/equinix_metalv1_spot-market_delete-spot-market-request.md b/docs/equinix_metalv1_spot-market_delete-spot-market-request.md new file mode 100644 index 0000000..5063452 --- /dev/null +++ b/docs/equinix_metalv1_spot-market_delete-spot-market-request.md @@ -0,0 +1,35 @@ +## equinix metalv1 spot-market delete-spot-market-request + +Delete the spot market request + +### Synopsis + +Deletes the spot market request. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 spot-market delete-spot-market-request [flags] +``` + +### Options + +``` + --force-termination force-termination field + -h, --help help for delete-spot-market-request + --id string SpotMarketRequest 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 spot-market](equinix_metalv1_spot-market.md) - Manage spot-market resources + diff --git a/docs/equinix_metalv1_spot-market_find-metro-spot-market-prices.md b/docs/equinix_metalv1_spot-market_find-metro-spot-market-prices.md new file mode 100644 index 0000000..2330336 --- /dev/null +++ b/docs/equinix_metalv1_spot-market_find-metro-spot-market-prices.md @@ -0,0 +1,35 @@ +## equinix metalv1 spot-market find-metro-spot-market-prices + +Get current spot market prices for metros + +### Synopsis + +Get Equinix Metal current spot market prices for all metros. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 spot-market find-metro-spot-market-prices [flags] +``` + +### Options + +``` + -h, --help help for find-metro-spot-market-prices + --metro string metro field + --plan string plan 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 spot-market](equinix_metalv1_spot-market.md) - Manage spot-market resources + diff --git a/docs/equinix_metalv1_spot-market_find-spot-market-prices-history.md b/docs/equinix_metalv1_spot-market_find-spot-market-prices-history.md new file mode 100644 index 0000000..9013f41 --- /dev/null +++ b/docs/equinix_metalv1_spot-market_find-spot-market-prices-history.md @@ -0,0 +1,38 @@ +## equinix metalv1 spot-market find-spot-market-prices-history + +Get spot market prices for a given period of time + +### Synopsis + +# Get spot market prices for a given plan and facility in a fixed period of time *Note: In the `200` response, the property `datapoints` contains arrays of `[float, integer]`.* + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 spot-market find-spot-market-prices-history [flags] +``` + +### Options + +``` + --facility string facility field + --from string from field + -h, --help help for find-spot-market-prices-history + --metro string metro field + --plan string plan field + --request string JSON payload for additional optional fields not exposed as flags + --until string until 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 spot-market](equinix_metalv1_spot-market.md) - Manage spot-market resources + diff --git a/docs/equinix_metalv1_spot-market_find-spot-market-prices.md b/docs/equinix_metalv1_spot-market_find-spot-market-prices.md new file mode 100644 index 0000000..25ce70a --- /dev/null +++ b/docs/equinix_metalv1_spot-market_find-spot-market-prices.md @@ -0,0 +1,35 @@ +## equinix metalv1 spot-market find-spot-market-prices + +Get current spot market prices + +### Synopsis + +Get Equinix Metal current spot market prices. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 spot-market find-spot-market-prices [flags] +``` + +### Options + +``` + --facility string facility field + -h, --help help for find-spot-market-prices + --plan string plan 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 spot-market](equinix_metalv1_spot-market.md) - Manage spot-market resources + diff --git a/docs/equinix_metalv1_spot-market_find-spot-market-request-by-id.md b/docs/equinix_metalv1_spot-market_find-spot-market-request-by-id.md new file mode 100644 index 0000000..4511c89 --- /dev/null +++ b/docs/equinix_metalv1_spot-market_find-spot-market-request-by-id.md @@ -0,0 +1,35 @@ +## equinix metalv1 spot-market find-spot-market-request-by-id + +Retrieve a spot market request + +### Synopsis + +Returns a single spot market request + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 spot-market find-spot-market-request-by-id [flags] +``` + +### Options + +``` + -h, --help help for find-spot-market-request-by-id + --id string SpotMarketRequest 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 spot-market](equinix_metalv1_spot-market.md) - Manage spot-market resources + diff --git a/docs/equinix_metalv1_spot-market_list-spot-market-requests.md b/docs/equinix_metalv1_spot-market_list-spot-market-requests.md new file mode 100644 index 0000000..feafc8d --- /dev/null +++ b/docs/equinix_metalv1_spot-market_list-spot-market-requests.md @@ -0,0 +1,34 @@ +## equinix metalv1 spot-market list-spot-market-requests + +List spot market requests + +### Synopsis + +View all spot market requests for a given project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 spot-market list-spot-market-requests [flags] +``` + +### Options + +``` + -h, --help help for list-spot-market-requests + --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 spot-market](equinix_metalv1_spot-market.md) - Manage spot-market resources + diff --git a/docs/equinix_metalv1_support-request.md b/docs/equinix_metalv1_support-request.md new file mode 100644 index 0000000..f978274 --- /dev/null +++ b/docs/equinix_metalv1_support-request.md @@ -0,0 +1,27 @@ +## equinix metalv1 support-request + +Manage support-request resources + +### Synopsis + +Commands for managing support-request resources in the API + +### Options + +``` + -h, --help help for support-request +``` + +### 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 support-request request-support](equinix_metalv1_support-request_request-support.md) - Create a support ticket + diff --git a/docs/equinix_metalv1_support-request_request-support.md b/docs/equinix_metalv1_support-request_request-support.md new file mode 100644 index 0000000..b31209d --- /dev/null +++ b/docs/equinix_metalv1_support-request_request-support.md @@ -0,0 +1,39 @@ +## equinix metalv1 support-request request-support + +Create a support ticket + +### Synopsis + +Support Ticket. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 support-request request-support [flags] +``` + +### Options + +``` + -h, --help help for request-support + --request string JSON payload for additional optional fields not exposed as flags + --support-request-input-additional-properties string support-request-input-additional-properties (JSON) + --support-request-input-device_id string support-request-input-device_id + --support-request-input-message string support-request-input-message + --support-request-input-priority string support-request-input-priority + --support-request-input-project_id string support-request-input-project_id + --support-request-input-subject string support-request-input-subject +``` + +### 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 support-request](equinix_metalv1_support-request.md) - Manage support-request resources + diff --git a/docs/equinix_metalv1_transfer-requests.md b/docs/equinix_metalv1_transfer-requests.md new file mode 100644 index 0000000..9beff28 --- /dev/null +++ b/docs/equinix_metalv1_transfer-requests.md @@ -0,0 +1,29 @@ +## equinix metalv1 transfer-requests + +Manage transfer-requests resources + +### Synopsis + +Commands for managing transfer-requests resources in the API + +### Options + +``` + -h, --help help for transfer-requests +``` + +### 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 transfer-requests accept-transfer-request](equinix_metalv1_transfer-requests_accept-transfer-request.md) - Accept a transfer request +* [equinix metalv1 transfer-requests decline-transfer-request](equinix_metalv1_transfer-requests_decline-transfer-request.md) - Decline a transfer request +* [equinix metalv1 transfer-requests find-transfer-request-by-id](equinix_metalv1_transfer-requests_find-transfer-request-by-id.md) - View a transfer request + diff --git a/docs/equinix_metalv1_transfer-requests_accept-transfer-request.md b/docs/equinix_metalv1_transfer-requests_accept-transfer-request.md new file mode 100644 index 0000000..da57d84 --- /dev/null +++ b/docs/equinix_metalv1_transfer-requests_accept-transfer-request.md @@ -0,0 +1,34 @@ +## equinix metalv1 transfer-requests accept-transfer-request + +Accept a transfer request + +### Synopsis + +Accept a transfer request. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 transfer-requests accept-transfer-request [flags] +``` + +### Options + +``` + -h, --help help for accept-transfer-request + --id string Transfer request 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 transfer-requests](equinix_metalv1_transfer-requests.md) - Manage transfer-requests resources + diff --git a/docs/equinix_metalv1_transfer-requests_decline-transfer-request.md b/docs/equinix_metalv1_transfer-requests_decline-transfer-request.md new file mode 100644 index 0000000..5cb2a07 --- /dev/null +++ b/docs/equinix_metalv1_transfer-requests_decline-transfer-request.md @@ -0,0 +1,34 @@ +## equinix metalv1 transfer-requests decline-transfer-request + +Decline a transfer request + +### Synopsis + +Decline a transfer request. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 transfer-requests decline-transfer-request [flags] +``` + +### Options + +``` + -h, --help help for decline-transfer-request + --id string Transfer request 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 transfer-requests](equinix_metalv1_transfer-requests.md) - Manage transfer-requests resources + diff --git a/docs/equinix_metalv1_transfer-requests_find-transfer-request-by-id.md b/docs/equinix_metalv1_transfer-requests_find-transfer-request-by-id.md new file mode 100644 index 0000000..6958f95 --- /dev/null +++ b/docs/equinix_metalv1_transfer-requests_find-transfer-request-by-id.md @@ -0,0 +1,35 @@ +## equinix metalv1 transfer-requests find-transfer-request-by-id + +View a transfer request + +### Synopsis + +Returns a single transfer request. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 transfer-requests find-transfer-request-by-id [flags] +``` + +### Options + +``` + -h, --help help for find-transfer-request-by-id + --id string Transfer request 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 transfer-requests](equinix_metalv1_transfer-requests.md) - Manage transfer-requests resources + diff --git a/docs/equinix_metalv1_two-factor-auth.md b/docs/equinix_metalv1_two-factor-auth.md new file mode 100644 index 0000000..dca2432 --- /dev/null +++ b/docs/equinix_metalv1_two-factor-auth.md @@ -0,0 +1,28 @@ +## equinix metalv1 two-factor-auth + +Manage two-factor-auth resources + +### Synopsis + +Commands for managing two-factor-auth resources in the API + +### Options + +``` + -h, --help help for two-factor-auth +``` + +### 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 two-factor-auth disable-tfa-app](equinix_metalv1_two-factor-auth_disable-tfa-app.md) - Disable two factor authentication +* [equinix metalv1 two-factor-auth enable-tfa-app](equinix_metalv1_two-factor-auth_enable-tfa-app.md) - Enable two factor auth using app + diff --git a/docs/equinix_metalv1_two-factor-auth_disable-tfa-app.md b/docs/equinix_metalv1_two-factor-auth_disable-tfa-app.md new file mode 100644 index 0000000..af27d75 --- /dev/null +++ b/docs/equinix_metalv1_two-factor-auth_disable-tfa-app.md @@ -0,0 +1,34 @@ +## equinix metalv1 two-factor-auth disable-tfa-app + +Disable two factor authentication + +### Synopsis + +Disables two factor authentication. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 two-factor-auth disable-tfa-app [flags] +``` + +### Options + +``` + -h, --help help for disable-tfa-app + --request string JSON payload for additional optional fields not exposed as flags + --x-otp-token string x-otp-token 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 two-factor-auth](equinix_metalv1_two-factor-auth.md) - Manage two-factor-auth resources + diff --git a/docs/equinix_metalv1_two-factor-auth_enable-tfa-app.md b/docs/equinix_metalv1_two-factor-auth_enable-tfa-app.md new file mode 100644 index 0000000..4947da9 --- /dev/null +++ b/docs/equinix_metalv1_two-factor-auth_enable-tfa-app.md @@ -0,0 +1,34 @@ +## equinix metalv1 two-factor-auth enable-tfa-app + +Enable two factor auth using app + +### Synopsis + +Enables two factor authentication using authenticator app. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 two-factor-auth enable-tfa-app [flags] +``` + +### Options + +``` + -h, --help help for enable-tfa-app + --request string JSON payload for additional optional fields not exposed as flags + --x-otp-token string x-otp-token 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 two-factor-auth](equinix_metalv1_two-factor-auth.md) - Manage two-factor-auth resources + diff --git a/docs/equinix_metalv1_usages.md b/docs/equinix_metalv1_usages.md new file mode 100644 index 0000000..6c55fb1 --- /dev/null +++ b/docs/equinix_metalv1_usages.md @@ -0,0 +1,28 @@ +## equinix metalv1 usages + +Manage usages resources + +### Synopsis + +Commands for managing usages resources in the API + +### Options + +``` + -h, --help help for usages +``` + +### 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 usages find-device-usages](equinix_metalv1_usages_find-device-usages.md) - Retrieve all usages for device +* [equinix metalv1 usages find-project-usage](equinix_metalv1_usages_find-project-usage.md) - Retrieve all usages for project + diff --git a/docs/equinix_metalv1_usages_find-device-usages.md b/docs/equinix_metalv1_usages_find-device-usages.md new file mode 100644 index 0000000..e695df4 --- /dev/null +++ b/docs/equinix_metalv1_usages_find-device-usages.md @@ -0,0 +1,36 @@ +## equinix metalv1 usages find-device-usages + +Retrieve all usages for device + +### Synopsis + +Returns all usages for a device. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 usages find-device-usages [flags] +``` + +### Options + +``` + --created-after string created-after field + --created-before string created-before field + -h, --help help for find-device-usages + --id string Device 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 usages](equinix_metalv1_usages.md) - Manage usages resources + diff --git a/docs/equinix_metalv1_usages_find-project-usage.md b/docs/equinix_metalv1_usages_find-project-usage.md new file mode 100644 index 0000000..fe24ece --- /dev/null +++ b/docs/equinix_metalv1_usages_find-project-usage.md @@ -0,0 +1,36 @@ +## equinix metalv1 usages find-project-usage + +Retrieve all usages for project + +### Synopsis + +Returns all usages for a project. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 usages find-project-usage [flags] +``` + +### Options + +``` + --created-after string created-after field + --created-before string created-before field + -h, --help help for find-project-usage + --id string Project 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 usages](equinix_metalv1_usages.md) - Manage usages resources + diff --git a/docs/equinix_metalv1_user-verification-tokens.md b/docs/equinix_metalv1_user-verification-tokens.md new file mode 100644 index 0000000..21d79f3 --- /dev/null +++ b/docs/equinix_metalv1_user-verification-tokens.md @@ -0,0 +1,28 @@ +## equinix metalv1 user-verification-tokens + +Manage user-verification-tokens resources + +### Synopsis + +Commands for managing user-verification-tokens resources in the API + +### Options + +``` + -h, --help help for user-verification-tokens +``` + +### 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 user-verification-tokens consume-verification-request](equinix_metalv1_user-verification-tokens_consume-verification-request.md) - Verify a user using an email verification token +* [equinix metalv1 user-verification-tokens create-validation-request](equinix_metalv1_user-verification-tokens_create-validation-request.md) - Create an email verification request + diff --git a/docs/equinix_metalv1_user-verification-tokens_consume-verification-request.md b/docs/equinix_metalv1_user-verification-tokens_consume-verification-request.md new file mode 100644 index 0000000..6de765b --- /dev/null +++ b/docs/equinix_metalv1_user-verification-tokens_consume-verification-request.md @@ -0,0 +1,36 @@ +## equinix metalv1 user-verification-tokens consume-verification-request + +Verify a user using an email verification token + +### Synopsis + +Consumes an email verification token and verifies the user associated with it. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 user-verification-tokens consume-verification-request [flags] +``` + +### Options + +``` + -h, --help help for consume-verification-request + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --verify-email-additional-properties string verify-email-additional-properties (JSON) + --verify-email-user_token string User verification 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 metalv1 user-verification-tokens](equinix_metalv1_user-verification-tokens.md) - Manage user-verification-tokens resources + diff --git a/docs/equinix_metalv1_user-verification-tokens_create-validation-request.md b/docs/equinix_metalv1_user-verification-tokens_create-validation-request.md new file mode 100644 index 0000000..20f840e --- /dev/null +++ b/docs/equinix_metalv1_user-verification-tokens_create-validation-request.md @@ -0,0 +1,35 @@ +## equinix metalv1 user-verification-tokens create-validation-request + +Create an email verification request + +### Synopsis + +Creates an email verification request + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 user-verification-tokens create-validation-request [flags] +``` + +### Options + +``` + -h, --help help for create-validation-request + --include string include field (JSON or string) + --login string login 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 user-verification-tokens](equinix_metalv1_user-verification-tokens.md) - Manage user-verification-tokens resources + diff --git a/docs/equinix_metalv1_userdata.md b/docs/equinix_metalv1_userdata.md new file mode 100644 index 0000000..4de0f6a --- /dev/null +++ b/docs/equinix_metalv1_userdata.md @@ -0,0 +1,27 @@ +## equinix metalv1 userdata + +Manage userdata resources + +### Synopsis + +Commands for managing userdata resources in the API + +### Options + +``` + -h, --help help for userdata +``` + +### 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 userdata validate-userdata](equinix_metalv1_userdata_validate-userdata.md) - Validate user data + diff --git a/docs/equinix_metalv1_userdata_validate-userdata.md b/docs/equinix_metalv1_userdata_validate-userdata.md new file mode 100644 index 0000000..f6ee4ef --- /dev/null +++ b/docs/equinix_metalv1_userdata_validate-userdata.md @@ -0,0 +1,34 @@ +## equinix metalv1 userdata validate-userdata + +Validate user data + +### Synopsis + +Validates user data (Userdata) + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 userdata validate-userdata [flags] +``` + +### Options + +``` + -h, --help help for validate-userdata + --request string JSON payload for additional optional fields not exposed as flags + --userdata string userdata 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 userdata](equinix_metalv1_userdata.md) - Manage userdata resources + diff --git a/docs/equinix_metalv1_users.md b/docs/equinix_metalv1_users.md new file mode 100644 index 0000000..5d133fb --- /dev/null +++ b/docs/equinix_metalv1_users.md @@ -0,0 +1,33 @@ +## equinix metalv1 users + +Manage users resources + +### Synopsis + +Commands for managing users resources in the API + +### Options + +``` + -h, --help help for users +``` + +### 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 users create-user](equinix_metalv1_users_create-user.md) - Create a user +* [equinix metalv1 users find-current-user](equinix_metalv1_users_find-current-user.md) - Retrieve the current user +* [equinix metalv1 users find-invitations](equinix_metalv1_users_find-invitations.md) - Retrieve current user invitations +* [equinix metalv1 users find-user-by-id](equinix_metalv1_users_find-user-by-id.md) - Retrieve a user +* [equinix metalv1 users find-user-customdata](equinix_metalv1_users_find-user-customdata.md) - Retrieve the custom metadata of a user +* [equinix metalv1 users find-users](equinix_metalv1_users_find-users.md) - Retrieve all users +* [equinix metalv1 users update-current-user](equinix_metalv1_users_update-current-user.md) - Update the current user + diff --git a/docs/equinix_metalv1_users_create-user.md b/docs/equinix_metalv1_users_create-user.md new file mode 100644 index 0000000..929e722 --- /dev/null +++ b/docs/equinix_metalv1_users_create-user.md @@ -0,0 +1,51 @@ +## equinix metalv1 users create-user + +Create a user + +### Synopsis + +Creates a user. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 users create-user [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for create-user + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --user-create-input-additional-properties string user-create-input-additional-properties (JSON) + --user-create-input-company_name string user-create-input-company_name + --user-create-input-company_url string user-create-input-company_url + --user-create-input-customdata string user-create-input-customdata (JSON) + --user-create-input-emails string user-create-input-emails (JSON array) + --user-create-input-first_name string user-create-input-first_name + --user-create-input-invitation_id string user-create-input-invitation_id + --user-create-input-last_name string user-create-input-last_name + --user-create-input-level string user-create-input-level + --user-create-input-nonce string user-create-input-nonce + --user-create-input-password string user-create-input-password + --user-create-input-phone_number string user-create-input-phone_number + --user-create-input-social_accounts string user-create-input-social_accounts (JSON) + --user-create-input-timezone string user-create-input-timezone + --user-create-input-title string user-create-input-title + --user-create-input-two_factor_auth string user-create-input-two_factor_auth +``` + +### 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 users](equinix_metalv1_users.md) - Manage users resources + diff --git a/docs/equinix_metalv1_users_find-current-user.md b/docs/equinix_metalv1_users_find-current-user.md new file mode 100644 index 0000000..740bb94 --- /dev/null +++ b/docs/equinix_metalv1_users_find-current-user.md @@ -0,0 +1,35 @@ +## equinix metalv1 users find-current-user + +Retrieve the current user + +### Synopsis + +Returns the user object for the currently logged-in user. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 users find-current-user [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-current-user + --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 users](equinix_metalv1_users.md) - Manage users resources + diff --git a/docs/equinix_metalv1_users_find-invitations.md b/docs/equinix_metalv1_users_find-invitations.md new file mode 100644 index 0000000..6393be6 --- /dev/null +++ b/docs/equinix_metalv1_users_find-invitations.md @@ -0,0 +1,36 @@ +## equinix metalv1 users find-invitations + +Retrieve current user invitations + +### Synopsis + +Returns all invitations in current user. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 users find-invitations [flags] +``` + +### Options + +``` + -h, --help help for find-invitations + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 users](equinix_metalv1_users.md) - Manage users resources + diff --git a/docs/equinix_metalv1_users_find-user-by-id.md b/docs/equinix_metalv1_users_find-user-by-id.md new file mode 100644 index 0000000..0b9252e --- /dev/null +++ b/docs/equinix_metalv1_users_find-user-by-id.md @@ -0,0 +1,36 @@ +## equinix metalv1 users find-user-by-id + +Retrieve a user + +### Synopsis + +Returns a single user if the user has access + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 users find-user-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-user-by-id + --id string User 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 users](equinix_metalv1_users.md) - Manage users resources + diff --git a/docs/equinix_metalv1_users_find-user-customdata.md b/docs/equinix_metalv1_users_find-user-customdata.md new file mode 100644 index 0000000..dc92b4c --- /dev/null +++ b/docs/equinix_metalv1_users_find-user-customdata.md @@ -0,0 +1,34 @@ +## equinix metalv1 users find-user-customdata + +Retrieve the custom metadata of a user + +### Synopsis + +Provides the custom metadata stored for this user in json format + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 users find-user-customdata [flags] +``` + +### Options + +``` + -h, --help help for find-user-customdata + --id string User 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 users](equinix_metalv1_users.md) - Manage users resources + diff --git a/docs/equinix_metalv1_users_find-users.md b/docs/equinix_metalv1_users_find-users.md new file mode 100644 index 0000000..07848ec --- /dev/null +++ b/docs/equinix_metalv1_users_find-users.md @@ -0,0 +1,37 @@ +## equinix metalv1 users find-users + +Retrieve all users + +### Synopsis + +Returns a list of users that the are accessible to the current user (all users in the current user’s projects, essentially). + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 users find-users [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-users + --include string include field (JSON or string) + --page int page field + --per-page int per-page 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 users](equinix_metalv1_users.md) - Manage users resources + diff --git a/docs/equinix_metalv1_users_update-current-user.md b/docs/equinix_metalv1_users_update-current-user.md new file mode 100644 index 0000000..ea39fe3 --- /dev/null +++ b/docs/equinix_metalv1_users_update-current-user.md @@ -0,0 +1,42 @@ +## equinix metalv1 users update-current-user + +Update the current user + +### Synopsis + +Updates the currently logged-in user. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix metalv1 users update-current-user [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for update-current-user + --include string include field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags + --user-update-input-additional-properties string user-update-input-additional-properties (JSON) + --user-update-input-customdata string user-update-input-customdata (JSON) + --user-update-input-first_name string user-update-input-first_name + --user-update-input-last_name string user-update-input-last_name + --user-update-input-password string user-update-input-password + --user-update-input-phone_number string user-update-input-phone_number + --user-update-input-timezone string user-update-input-timezone +``` + +### 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 users](equinix_metalv1_users.md) - Manage users resources + diff --git a/docs/equinix_metalv1_v-l-a-ns.md b/docs/equinix_metalv1_v-l-a-ns.md new file mode 100644 index 0000000..155d6e3 --- /dev/null +++ b/docs/equinix_metalv1_v-l-a-ns.md @@ -0,0 +1,31 @@ +## 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_create-virtual-network.md b/docs/equinix_metalv1_v-l-a-ns_create-virtual-network.md new file mode 100644 index 0000000..4666e86 --- /dev/null +++ b/docs/equinix_metalv1_v-l-a-ns_create-virtual-network.md @@ -0,0 +1,46 @@ +## equinix metalv1 v-l-a-ns create-virtual-network + +Execute create-virtual-network operation + +### Synopsis + +Execute the create-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 create-virtual-network [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for create-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 + --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 + --virtual-network-create-input-facility string The UUID (or facility code) for the Facility in which to create this Virtual network. + Deprecated + --virtual-network-create-input-metro string The UUID (or metro code) for the Metro in which to create this Virtual Network. + --virtual-network-create-input-tags string virtual-network-create-input-tags (JSON array) + --virtual-network-create-input-vxlan int VLAN ID between 2-3999. Must be unique for the project within the Metro in which this Virtual Network is being created. If no value is specified, the next-available VLAN ID in the range 1000-1999 will be automatically selected. +``` + +### 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_delete-virtual-network.md b/docs/equinix_metalv1_v-l-a-ns_delete-virtual-network.md new file mode 100644 index 0000000..4df7ca6 --- /dev/null +++ b/docs/equinix_metalv1_v-l-a-ns_delete-virtual-network.md @@ -0,0 +1,39 @@ +## 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 new file mode 100644 index 0000000..6a31379 --- /dev/null +++ b/docs/equinix_metalv1_v-l-a-ns_find-virtual-networks.md @@ -0,0 +1,41 @@ +## 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 new file mode 100644 index 0000000..73ef0de --- /dev/null +++ b/docs/equinix_metalv1_v-l-a-ns_get-virtual-network.md @@ -0,0 +1,39 @@ +## 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-l-a-ns_update-virtual-network.md b/docs/equinix_metalv1_v-l-a-ns_update-virtual-network.md new file mode 100644 index 0000000..df48c1e --- /dev/null +++ b/docs/equinix_metalv1_v-l-a-ns_update-virtual-network.md @@ -0,0 +1,42 @@ +## equinix metalv1 v-l-a-ns update-virtual-network + +Execute update-virtual-network operation + +### Synopsis + +Execute the update-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 update-virtual-network [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for update-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 + --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 + --virtual-network-update-input-tags string virtual-network-update-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 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 new file mode 100644 index 0000000..bb7a968 --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs.md @@ -0,0 +1,42 @@ +## 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_bgp-dynamic-neighbors-id-get.md b/docs/equinix_metalv1_v-r-fs_bgp-dynamic-neighbors-id-get.md new file mode 100644 index 0000000..81d21d5 --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_bgp-dynamic-neighbors-id-get.md @@ -0,0 +1,39 @@ +## equinix metalv1 v-r-fs bgp-dynamic-neighbors-id-get + +Execute bgp-dynamic-neighbors-id-get operation + +### Synopsis + +Execute the bgp-dynamic-neighbors-id-get 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 bgp-dynamic-neighbors-id-get [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for bgp-dynamic-neighbors-id-get + --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 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources + diff --git a/docs/equinix_metalv1_v-r-fs_create-vrf-route.md b/docs/equinix_metalv1_v-r-fs_create-vrf-route.md new file mode 100644 index 0000000..c2fb268 --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_create-vrf-route.md @@ -0,0 +1,43 @@ +## equinix metalv1 v-r-fs create-vrf-route + +Execute create-vrf-route operation + +### Synopsis + +Execute the create-vrf-route 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 create-vrf-route [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for create-vrf-route + --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 + --vrf-route-create-input-prefix string The IPv4 prefix for the route, in CIDR-style notation. For a static default route, this will always be \"0.0.0.0/0\" + --vrf-route-create-input-tags string vrf-route-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 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources + diff --git a/docs/equinix_metalv1_v-r-fs_create-vrf.md b/docs/equinix_metalv1_v-r-fs_create-vrf.md new file mode 100644 index 0000000..de7cfca --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_create-vrf.md @@ -0,0 +1,49 @@ +## equinix metalv1 v-r-fs create-vrf + +Execute create-vrf operation + +### Synopsis + +Execute the create-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 create-vrf [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for create-vrf + --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 + --vrf-create-input-bgp_dynamic_neighbors_enabled Toggle to enable the dynamic bgp neighbors feature on the VRF + --vrf-create-input-bgp_dynamic_neighbors_export_route_map Toggle to export the VRF route-map to the dynamic bgp neighbors + --vrf-create-input-description string vrf-create-input-description + --vrf-create-input-ip_ranges string A list of CIDR network addresses. Like [\"10.0.0.0/16\", \"2001:d78::/59\"]. IPv4 blocks must be between /8 and /29 in size. IPv6 blocks must be between /59 and /64. A VRF\\'s IP ranges must be defined in order to create VRF IP Reservations, which can then be used for Metal Gateways or Virtual Circuits. (JSON array) + --vrf-create-input-local_asn int vrf-create-input-local_asn + --vrf-create-input-metro string The UUID (or metro code) for the Metro in which to create this VRF. + --vrf-create-input-name string vrf-create-input-name + --vrf-create-input-tags string vrf-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 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources + diff --git a/docs/equinix_metalv1_v-r-fs_delete-bgp-dynamic-neighbor-by-id.md b/docs/equinix_metalv1_v-r-fs_delete-bgp-dynamic-neighbor-by-id.md new file mode 100644 index 0000000..f11e088 --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_delete-bgp-dynamic-neighbor-by-id.md @@ -0,0 +1,39 @@ +## equinix metalv1 v-r-fs delete-bgp-dynamic-neighbor-by-id + +Execute delete-bgp-dynamic-neighbor-by-id operation + +### Synopsis + +Execute the delete-bgp-dynamic-neighbor-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 v-r-fs delete-bgp-dynamic-neighbor-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for delete-bgp-dynamic-neighbor-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 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources + diff --git a/docs/equinix_metalv1_v-r-fs_delete-vrf-route-by-id.md b/docs/equinix_metalv1_v-r-fs_delete-vrf-route-by-id.md new file mode 100644 index 0000000..1c3b14c --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_delete-vrf-route-by-id.md @@ -0,0 +1,39 @@ +## equinix metalv1 v-r-fs delete-vrf-route-by-id + +Execute delete-vrf-route-by-id operation + +### Synopsis + +Execute the delete-vrf-route-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 v-r-fs delete-vrf-route-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for delete-vrf-route-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 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources + diff --git a/docs/equinix_metalv1_v-r-fs_delete-vrf.md b/docs/equinix_metalv1_v-r-fs_delete-vrf.md new file mode 100644 index 0000000..a52057b --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_delete-vrf.md @@ -0,0 +1,37 @@ +## 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_find-vrf-by-id.md b/docs/equinix_metalv1_v-r-fs_find-vrf-by-id.md new file mode 100644 index 0000000..7eae843 --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_find-vrf-by-id.md @@ -0,0 +1,39 @@ +## equinix metalv1 v-r-fs find-vrf-by-id + +Execute find-vrf-by-id operation + +### Synopsis + +Execute the find-vrf-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 v-r-fs find-vrf-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-vrf-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 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources + diff --git a/docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservation.md b/docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservation.md new file mode 100644 index 0000000..876535f --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservation.md @@ -0,0 +1,40 @@ +## equinix metalv1 v-r-fs find-vrf-ip-reservation + +Execute find-vrf-ip-reservation operation + +### Synopsis + +Execute the find-vrf-ip-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 v-r-fs find-vrf-ip-reservation [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-vrf-ip-reservation + --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 +``` + +### 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_find-vrf-ip-reservations.md b/docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservations.md new file mode 100644 index 0000000..f8dc741 --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_find-vrf-ip-reservations.md @@ -0,0 +1,39 @@ +## equinix metalv1 v-r-fs find-vrf-ip-reservations + +Execute find-vrf-ip-reservations operation + +### Synopsis + +Execute the find-vrf-ip-reservations 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 find-vrf-ip-reservations [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-vrf-ip-reservations + --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 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources + diff --git a/docs/equinix_metalv1_v-r-fs_find-vrf-route-by-id.md b/docs/equinix_metalv1_v-r-fs_find-vrf-route-by-id.md new file mode 100644 index 0000000..6cbc968 --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_find-vrf-route-by-id.md @@ -0,0 +1,39 @@ +## equinix metalv1 v-r-fs find-vrf-route-by-id + +Execute find-vrf-route-by-id operation + +### Synopsis + +Execute the find-vrf-route-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 v-r-fs find-vrf-route-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-vrf-route-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 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources + diff --git a/docs/equinix_metalv1_v-r-fs_find-vrfs.md b/docs/equinix_metalv1_v-r-fs_find-vrfs.md new file mode 100644 index 0000000..4f4d9ca --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_find-vrfs.md @@ -0,0 +1,40 @@ +## equinix metalv1 v-r-fs find-vrfs + +Execute find-vrfs operation + +### Synopsis + +Execute the find-vrfs 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 find-vrfs [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for find-vrfs + --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 +``` + +### 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 new file mode 100644 index 0000000..1a21a3c --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_get-vrf-b-g-p-neighbors.md @@ -0,0 +1,37 @@ +## 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 new file mode 100644 index 0000000..8305488 --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_get-vrf-learned-routes.md @@ -0,0 +1,37 @@ +## 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_v-r-fs_get-vrf-routes.md b/docs/equinix_metalv1_v-r-fs_get-vrf-routes.md new file mode 100644 index 0000000..610a58c --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_get-vrf-routes.md @@ -0,0 +1,39 @@ +## equinix metalv1 v-r-fs get-vrf-routes + +Execute get-vrf-routes operation + +### Synopsis + +Execute the get-vrf-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-routes [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for get-vrf-routes + --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 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources + diff --git a/docs/equinix_metalv1_v-r-fs_update-vrf-route-by-id.md b/docs/equinix_metalv1_v-r-fs_update-vrf-route-by-id.md new file mode 100644 index 0000000..3a2401d --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_update-vrf-route-by-id.md @@ -0,0 +1,43 @@ +## equinix metalv1 v-r-fs update-vrf-route-by-id + +Execute update-vrf-route-by-id operation + +### Synopsis + +Execute the update-vrf-route-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 v-r-fs update-vrf-route-by-id [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for update-vrf-route-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 + --vrf-route-update-input-additional-properties string vrf-route-update-input-additional-properties (JSON) + --vrf-route-update-input-next_hop string The IPv4 address within the VRF of the host that will handle this route + --vrf-route-update-input-prefix string The IPv4 prefix for the route, in CIDR-style notation. For a static default route, this will always be \"0.0.0.0/0\" + --vrf-route-update-input-tags string vrf-route-update-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 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources + diff --git a/docs/equinix_metalv1_v-r-fs_update-vrf.md b/docs/equinix_metalv1_v-r-fs_update-vrf.md new file mode 100644 index 0000000..e888cd1 --- /dev/null +++ b/docs/equinix_metalv1_v-r-fs_update-vrf.md @@ -0,0 +1,48 @@ +## equinix metalv1 v-r-fs update-vrf + +Execute update-vrf operation + +### Synopsis + +Execute the update-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 update-vrf [flags] +``` + +### Options + +``` + --exclude string exclude field (JSON or string) + -h, --help help for update-vrf + --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 + --vrf-update-input-bgp_dynamic_neighbors_enabled Toggle to enable the dynamic bgp neighbors feature on the VRF + --vrf-update-input-bgp_dynamic_neighbors_export_route_map Toggle to export the VRF route-map to the dynamic bgp neighbors + --vrf-update-input-description string vrf-update-input-description + --vrf-update-input-ip_ranges ip_ranges A list of CIDR network addresses. Like [\"10.0.0.0/16\", \"2001:d78::/59\"]. IPv4 blocks must be between /8 and /29 in size. IPv6 blocks must be between /59 and /64. A VRF\\'s IP ranges must be defined in order to create VRF IP Reservations, which can then be used for Metal Gateways or Virtual Circuits. Adding a new CIDR address to the list will result in the creation of a new IP Range for this VRF. Removal of an existing CIDR address from the list will result in the deletion of an existing IP Range for this VRF. Deleting an IP Range will result in the deletion of any VRF IP Reservations contained within the IP Range, as well as the VRF IP Reservation\\'s associated Metal Gateways or Virtual Circuits. If you do not wish to add or remove IP Ranges, either include the full existing list of IP Ranges in the update request, or do not specify the ip_ranges field in the update request. Specifying a value of `[]` will remove all existing IP Ranges from the VRF. (JSON array) + --vrf-update-input-local_asn local_asn The new local_asn value for the VRF. This field cannot be updated when there are active Interconnection Virtual Circuits associated to the VRF, or if any of the VLANs of the VRF's metal gateway has been assigned on an instance. + --vrf-update-input-name string vrf-update-input-name + --vrf-update-input-tags string vrf-update-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 v-r-fs](equinix_metalv1_v-r-fs.md) - Manage v-r-fs resources + diff --git a/docs/equinix_orderhistoryv1.md b/docs/equinix_orderhistoryv1.md new file mode 100644 index 0000000..91092b8 --- /dev/null +++ b/docs/equinix_orderhistoryv1.md @@ -0,0 +1,30 @@ +## equinix orderhistoryv1 + +Manage Equinix orderhistoryv1 resources + +### Synopsis + +Commands for managing Equinix orderhistoryv1 resources. + +The orderhistoryv1 commands are dynamically generated based on the orderhistoryv1 API client, +providing access to all available API services. + +### Options + +``` + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") + -h, --help help for orderhistoryv1 +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) +``` + +### SEE ALSO + +* [equinix](equinix.md) - Equinix CLI +* [equinix orderhistoryv1 retrieve-orders](equinix_orderhistoryv1_retrieve-orders.md) - Manage retrieve-orders resources + diff --git a/docs/equinix_orderhistoryv1_retrieve-orders.md b/docs/equinix_orderhistoryv1_retrieve-orders.md new file mode 100644 index 0000000..51a3102 --- /dev/null +++ b/docs/equinix_orderhistoryv1_retrieve-orders.md @@ -0,0 +1,28 @@ +## equinix orderhistoryv1 retrieve-orders + +Manage retrieve-orders resources + +### Synopsis + +Commands for managing retrieve-orders resources in the API + +### Options + +``` + -h, --help help for retrieve-orders +``` + +### 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 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 + diff --git a/docs/equinix_orderhistoryv1_retrieve-orders_g-e-t-retrieve-orders-locations.md b/docs/equinix_orderhistoryv1_retrieve-orders_g-e-t-retrieve-orders-locations.md new file mode 100644 index 0000000..52739ee --- /dev/null +++ b/docs/equinix_orderhistoryv1_retrieve-orders_g-e-t-retrieve-orders-locations.md @@ -0,0 +1,34 @@ +## equinix orderhistoryv1 retrieve-orders g-e-t-retrieve-orders-locations + +Retrieve order permissible IBX locations + +### Synopsis + +The API returns locations (IBXs and Cages) where the user's organization has a presence. The user may be able to view orders related to these locations, depending on their permissions. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix orderhistoryv1 retrieve-orders g-e-t-retrieve-orders-locations [flags] +``` + +### Options + +``` + --authorization string authorization field + -h, --help help for g-e-t-retrieve-orders-locations + --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 orderhistoryv1 retrieve-orders](equinix_orderhistoryv1_retrieve-orders.md) - Manage retrieve-orders resources + diff --git a/docs/equinix_orderhistoryv1_retrieve-orders_p-o-s-t-orders-history.md b/docs/equinix_orderhistoryv1_retrieve-orders_p-o-s-t-orders-history.md new file mode 100644 index 0000000..7cfb84a --- /dev/null +++ b/docs/equinix_orderhistoryv1_retrieve-orders_p-o-s-t-orders-history.md @@ -0,0 +1,48 @@ +## equinix orderhistoryv1 retrieve-orders p-o-s-t-orders-history + +Search Orders History + +### Synopsis + +Based on filtering criteria, this method returns a list of orders from the last 12 months for IBX locations where the user has permissions. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix orderhistoryv1 retrieve-orders p-o-s-t-orders-history [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-filters-additional-properties string body-filters-additional-properties (JSON) + --body-filters-date-range string body-filters-date-range + --body-filters-from-date string Date Format Should be mm/dd/yyyy.
Not applicable when dateRange is provided. + --body-filters-ibxs string ibxs filter (JSON array) + --body-filters-order-status string order status filter (JSON array) + --body-filters-product-types string Product(order type) filter (JSON array) + --body-filters-to-date string Date Format Should be mm/dd/yyyy.
Not applicable when dateRange is provided + --body-page-additional-properties string body-page-additional-properties (JSON) + --body-page-number int Page number indexed from 0. + --body-page-size int Page Size. + --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 + --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 orderhistoryv1 retrieve-orders](equinix_orderhistoryv1_retrieve-orders.md) - Manage retrieve-orders resources + diff --git a/docs/equinix_ordersv2.md b/docs/equinix_ordersv2.md new file mode 100644 index 0000000..f389331 --- /dev/null +++ b/docs/equinix_ordersv2.md @@ -0,0 +1,30 @@ +## equinix ordersv2 + +Manage Equinix ordersv2 resources + +### Synopsis + +Commands for managing Equinix ordersv2 resources. + +The ordersv2 commands are dynamically generated based on the ordersv2 API client, +providing access to all available API services. + +### Options + +``` + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") + -h, --help help for ordersv2 +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) +``` + +### SEE ALSO + +* [equinix](equinix.md) - Equinix CLI +* [equinix ordersv2 orders](equinix_ordersv2_orders.md) - Manage orders resources + diff --git a/docs/equinix_ordersv2_orders.md b/docs/equinix_ordersv2_orders.md new file mode 100644 index 0000000..8cd8a10 --- /dev/null +++ b/docs/equinix_ordersv2_orders.md @@ -0,0 +1,31 @@ +## equinix ordersv2 orders + +Manage orders resources + +### Synopsis + +Commands for managing orders resources in the API + +### Options + +``` + -h, --help help for orders +``` + +### 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 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 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_add-notes-to-an-order.md b/docs/equinix_ordersv2_orders_add-notes-to-an-order.md new file mode 100644 index 0000000..2fd9a14 --- /dev/null +++ b/docs/equinix_ordersv2_orders_add-notes-to-an-order.md @@ -0,0 +1,38 @@ +## equinix ordersv2 orders add-notes-to-an-order + +Add notes to an order + +### Synopsis + +This method adds notes to an order by its ID for a user with permission to view this request. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix ordersv2 orders add-notes-to-an-order [flags] +``` + +### Options + +``` + -h, --help help for add-notes-to-an-order + --note-request-additional-properties string note-request-additional-properties (JSON) + --note-request-attachments string File(s) attached to the Orders. To learn about including attachments in your request, see POST Attachments API. (JSON array) + --note-request-reference-id string Unique reference ID associated with notes. + --note-request-text string The text of the note + --order-id string Identifier of the order (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 ordersv2 orders](equinix_ordersv2_orders.md) - Manage orders resources + diff --git a/docs/equinix_ordersv2_orders_cancel-an-order.md b/docs/equinix_ordersv2_orders_cancel-an-order.md new file mode 100644 index 0000000..3f7569a --- /dev/null +++ b/docs/equinix_ordersv2_orders_cancel-an-order.md @@ -0,0 +1,38 @@ +## equinix ordersv2 orders cancel-an-order + +Cancel an order + +### Synopsis + +This method cancels an order by its ID for a user with permission to view this request. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix ordersv2 orders cancel-an-order [flags] +``` + +### Options + +``` + --cancel-request-additional-properties string cancel-request-additional-properties (JSON) + --cancel-request-attachments string File(s) attached (JSON array) + --cancel-request-line-ids lineId Refers to the lineId of product/service. (JSON array) + --cancel-request-reason string Reason for cancellation + -h, --help help for cancel-an-order + --order-id string Identifier of the order (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 ordersv2 orders](equinix_ordersv2_orders.md) - Manage orders resources + diff --git a/docs/equinix_ordersv2_orders_g-e-t-order-details.md b/docs/equinix_ordersv2_orders_g-e-t-order-details.md new file mode 100644 index 0000000..e58d058 --- /dev/null +++ b/docs/equinix_ordersv2_orders_g-e-t-order-details.md @@ -0,0 +1,35 @@ +## equinix ordersv2 orders g-e-t-order-details + +Retrieve an order + +### Synopsis + +This method retrieves an order by its ID for a user with permission to view this request. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix ordersv2 orders g-e-t-order-details [flags] +``` + +### Options + +``` + -h, --help help for g-e-t-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 +``` + +### 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 ordersv2 orders](equinix_ordersv2_orders.md) - Manage orders resources + diff --git a/docs/equinix_ordersv2_orders_reply-to-an-order-negotiation.md b/docs/equinix_ordersv2_orders_reply-to-an-order-negotiation.md new file mode 100644 index 0000000..5c30a54 --- /dev/null +++ b/docs/equinix_ordersv2_orders_reply-to-an-order-negotiation.md @@ -0,0 +1,38 @@ +## equinix ordersv2 orders reply-to-an-order-negotiation + +Reply to an order negotiation + +### Synopsis + +This method approves or rejects an order negotiation for a user with permission to view this request. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix ordersv2 orders reply-to-an-order-negotiation [flags] +``` + +### Options + +``` + -h, --help help for reply-to-an-order-negotiation + --negotiations-request-action string negotiations-request-action + --negotiations-request-additional-properties string negotiations-request-additional-properties (JSON) + --negotiations-request-reason string Reason for cancelling the negotiation + --negotiations-request-reference-id string Unique identifier to reference specific activity or order line id. + --order-id string Identifier of the order (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 ordersv2 orders](equinix_ordersv2_orders.md) - Manage orders resources + diff --git a/docs/equinix_ordersv2_orders_retrieve-order-negotiations.md b/docs/equinix_ordersv2_orders_retrieve-order-negotiations.md new file mode 100644 index 0000000..6c642b4 --- /dev/null +++ b/docs/equinix_ordersv2_orders_retrieve-order-negotiations.md @@ -0,0 +1,34 @@ +## equinix ordersv2 orders retrieve-order-negotiations + +Retrieve order negotiations + +### Synopsis + +This method retrieves order negotiations by its ID for a user with permission to view this request. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix ordersv2 orders retrieve-order-negotiations [flags] +``` + +### Options + +``` + -h, --help help for retrieve-order-negotiations + --order-id string Identifier of the order (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 ordersv2 orders](equinix_ordersv2_orders.md) - Manage orders resources + diff --git a/docs/equinix_securecabinetv1.md b/docs/equinix_securecabinetv1.md new file mode 100644 index 0000000..ff8bf55 --- /dev/null +++ b/docs/equinix_securecabinetv1.md @@ -0,0 +1,31 @@ +## equinix securecabinetv1 + +Manage Equinix securecauinetv1 resources + +### Synopsis + +Commands for managing Equinix securecauinetv1 resources. + +The securecabinetv1 commands are dynamically generated based on the securecauinetv1 API client, +providing access to all available API services. + +### Options + +``` + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") + -h, --help help for securecabinetv1 +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) +``` + +### SEE ALSO + +* [equinix](equinix.md) - Equinix CLI +* [equinix securecabinetv1 availability](equinix_securecabinetv1_availability.md) - Manage availability resources +* [equinix securecabinetv1 orders](equinix_securecabinetv1_orders.md) - Manage orders resources + diff --git a/docs/equinix_securecabinetv1_availability.md b/docs/equinix_securecabinetv1_availability.md new file mode 100644 index 0000000..121e195 --- /dev/null +++ b/docs/equinix_securecabinetv1_availability.md @@ -0,0 +1,27 @@ +## equinix securecabinetv1 availability + +Manage availability resources + +### Synopsis + +Commands for managing availability resources in the API + +### Options + +``` + -h, --help help for availability +``` + +### 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 securecabinetv1](equinix_securecabinetv1.md) - Manage Equinix securecauinetv1 resources +* [equinix securecabinetv1 availability get-products-availability](equinix_securecabinetv1_availability_get-products-availability.md) - Secure Cabinet availability. + diff --git a/docs/equinix_securecabinetv1_availability_get-products-availability.md b/docs/equinix_securecabinetv1_availability_get-products-availability.md new file mode 100644 index 0000000..a526148 --- /dev/null +++ b/docs/equinix_securecabinetv1_availability_get-products-availability.md @@ -0,0 +1,34 @@ +## equinix securecabinetv1 availability get-products-availability + +Secure Cabinet availability. + +### Synopsis + +Returns the availability of Secure Cabinets and recommended additional products for provided billing account. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix securecabinetv1 availability get-products-availability [flags] +``` + +### Options + +``` + --account-number string Billing Account Number. (required) + -h, --help help for get-products-availability + --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 securecabinetv1 availability](equinix_securecabinetv1_availability.md) - Manage availability resources + diff --git a/docs/equinix_securecabinetv1_orders.md b/docs/equinix_securecabinetv1_orders.md new file mode 100644 index 0000000..5501c68 --- /dev/null +++ b/docs/equinix_securecabinetv1_orders.md @@ -0,0 +1,27 @@ +## equinix securecabinetv1 orders + +Manage orders resources + +### Synopsis + +Commands for managing orders resources in the API + +### Options + +``` + -h, --help help for orders +``` + +### 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 securecabinetv1](equinix_securecabinetv1.md) - Manage Equinix securecauinetv1 resources +* [equinix securecabinetv1 orders create-order](equinix_securecabinetv1_orders_create-order.md) - Order a new Secure Cabinet deployment + diff --git a/docs/equinix_securecabinetv1_orders_create-order.md b/docs/equinix_securecabinetv1_orders_create-order.md new file mode 100644 index 0000000..1d63277 --- /dev/null +++ b/docs/equinix_securecabinetv1_orders_create-order.md @@ -0,0 +1,51 @@ +## equinix securecabinetv1 orders create-order + +Order a new Secure Cabinet deployment + +### Synopsis + +Order a new Secure Cabinet deployment and recommended additional products at IBX data centers worldwide. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix securecabinetv1 orders create-order [flags] +``` + +### Options + +``` + -h, --help help for create-order + --order-create-request-account-number string Identifier of a billing account, with permission to order colocation products. + --order-create-request-additional-properties string order-create-request-additional-properties (JSON) + --order-create-request-contract-term string order-create-request-contract-term + --order-create-request-customer-reference string Supplementary identifier for your discretionary use. For example, your internal identifier. + --order-create-request-end-customer-name string End customer name. Applicable and required if a reseller billing account is used. + --order-create-request-ibx-code string IBX data center identifier. + --order-create-request-order-item-additional-properties string order-create-request-order-item-additional-properties (JSON) + --order-create-request-order-item-cabinet-dimensions string order-create-request-order-item-cabinet-dimensions (JSON) + --order-create-request-order-item-draw-capacity float Maximum, combined power draw of all cabinets in your order, measured in kVA. Applicable values, in 0.5 increments, depend on the IBX data center. + --order-create-request-order-item-fabric-port Indicates if a single, primary Fabric port should be included and delivered to one of the ordered cabinets. + --order-create-request-order-item-number-of-cabinets int The number of ordered cabinets. + --order-create-request-order-item-pdus Indicates if an Equinix-recommended set of two PDUs, for single-phase circuit, per cabinet should be installed. + --order-create-request-purchase-order-number string Purchase order number. Optional, unless the billing account requires it. + --order-create-request-technical-contact-additional-properties string order-create-request-technical-contact-additional-properties (JSON) + --order-create-request-technical-contact-email string Email address. + --order-create-request-technical-contact-first-name string First name. + --order-create-request-technical-contact-last-name string Last name. + --order-create-request-technical-contact-phone string order-create-request-technical-contact-phone (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 securecabinetv1 orders](equinix_securecabinetv1_orders.md) - Manage orders resources + diff --git a/docs/equinix_smarthandsv1.md b/docs/equinix_smarthandsv1.md new file mode 100644 index 0000000..d5da1e0 --- /dev/null +++ b/docs/equinix_smarthandsv1.md @@ -0,0 +1,30 @@ +## equinix smarthandsv1 + +Manage Equinix smarthandsv1 resources + +### Synopsis + +Commands for managing Equinix smarthandsv1 resources. + +The smarthandsv1 commands are dynamically generated based on the smarthandsv1 API client, +providing access to all available API services. + +### Options + +``` + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") + -h, --help help for smarthandsv1 +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) +``` + +### SEE ALSO + +* [equinix](equinix.md) - Equinix CLI +* [equinix smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands.md b/docs/equinix_smarthandsv1_smarthands.md new file mode 100644 index 0000000..78f75e0 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands.md @@ -0,0 +1,40 @@ +## equinix smarthandsv1 smarthands + +Manage smarthands resources + +### Synopsis + +Commands for managing smarthands resources in the API + +### Options + +``` + -h, --help help for smarthands +``` + +### 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 smarthandsv1](equinix_smarthandsv1.md) - Manage Equinix smarthandsv1 resources +* [equinix smarthandsv1 smarthands get-location](equinix_smarthandsv1_smarthands_get-location.md) - Get locations(ibx, cage) details for placing smart hands based on smart hands permission for user +* [equinix smarthandsv1 smarthands handle-smart-hand-cable-request-order](equinix_smarthandsv1_smarthands_handle-smart-hand-cable-request-order.md) - This API is used to request cables per your specifications for your equipment. +* [equinix smarthandsv1 smarthands handle-smart-hand-cage-cleanup-order](equinix_smarthandsv1_smarthands_handle-smart-hand-cage-cleanup-order.md) - Request trash removal or cage cleanup +* [equinix smarthandsv1 smarthands handle-smart-hand-cage-escort-order](equinix_smarthandsv1_smarthands_handle-smart-hand-cage-escort-order.md) - Request a patch cable to be moved between devices +* [equinix smarthandsv1 smarthands handle-smart-hand-locate-package-order](equinix_smarthandsv1_smarthands_handle-smart-hand-locate-package-order.md) - Get the location of your package(s) at an IBX. +* [equinix smarthandsv1 smarthands handle-smart-hand-move-jumper-cable-order](equinix_smarthandsv1_smarthands_handle-smart-hand-move-jumper-cable-order.md) - This API is used to request a patch cable to be moved between devices. +* [equinix smarthandsv1 smarthands handle-smart-hand-order](equinix_smarthandsv1_smarthands_handle-smart-hand-order.md) - Request equipment installation per your specifications by an IBX Technician +* [equinix smarthandsv1 smarthands handle-smart-hand-others-order](equinix_smarthandsv1_smarthands_handle-smart-hand-others-order.md) - Request a Smart Hands order not listed in catalogue +* [equinix smarthandsv1 smarthands handle-smart-hand-patch-cable-install-order](equinix_smarthandsv1_smarthands_handle-smart-hand-patch-cable-install-order.md) - Request installation of a cross connect patch cable by an IBX Technician. +* [equinix smarthandsv1 smarthands handle-smart-hand-patch-cable-removal-order](equinix_smarthandsv1_smarthands_handle-smart-hand-patch-cable-removal-order.md) - Request removal of a cross connect cable by an IBX Technician. +* [equinix smarthandsv1 smarthands handle-smart-hand-pictures-document-order](equinix_smarthandsv1_smarthands_handle-smart-hand-pictures-document-order.md) - Request an IBX Technician to provide cage-related pictures or documentation. +* [equinix smarthandsv1 smarthands handle-smart-hand-run-jumper-cable-order](equinix_smarthandsv1_smarthands_handle-smart-hand-run-jumper-cable-order.md) - This API is used to request a jumper cable to be ran between devices. +* [equinix smarthandsv1 smarthands handle-smart-hand-shipment-unpack-order](equinix_smarthandsv1_smarthands_handle-smart-hand-shipment-unpack-order.md) - Request inbound shipment unpacking and packaging disposal. +* [equinix smarthandsv1 smarthands smart-hand-types](equinix_smarthandsv1_smarthands_smart-hand-types.md) - All supported smart hands types API. + diff --git a/docs/equinix_smarthandsv1_smarthands_get-location.md b/docs/equinix_smarthandsv1_smarthands_get-location.md new file mode 100644 index 0000000..c550e21 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_get-location.md @@ -0,0 +1,37 @@ +## equinix smarthandsv1 smarthands get-location + +Get locations(ibx, cage) details for placing smart hands based on smart hands permission for user + +### Synopsis + +Get locations(ibx, cage) details for placing smart hands based on smart hands permission for user + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands get-location [flags] +``` + +### Options + +``` + --authorization string authorization field + --cages string cages field + --detail detail field + -h, --help help for get-location + --ibxs string ibxs 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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cable-request-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cable-request-order.md new file mode 100644 index 0000000..dafbbb5 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cable-request-order.md @@ -0,0 +1,54 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-cable-request-order + +This API is used to request cables per your specifications for your equipment. + +### Synopsis + +This API is used to request cables per your specifications for your equipment. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-cable-request-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-connector-type string body-service-details-connector-type + --body-service-details-length string Length (feet/cm). + --body-service-details-media-type string body-service-details-media-type + --body-service-details-quantity string body-service-details-quantity + --body-service-details-scope-of-work string Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field. + -h, --help help for handle-smart-hand-cable-request-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cage-cleanup-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cage-cleanup-order.md new file mode 100644 index 0000000..5112f78 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cage-cleanup-order.md @@ -0,0 +1,52 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-cage-cleanup-order + +Request trash removal or cage cleanup + +### Synopsis + +This API is used to request trash removal or cage cleanup + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-cage-cleanup-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-damp-moist-mop-required Is Damp Moist Mop Requested? + --body-service-details-permission-to-discard-boxes Permission To Discard Boxes? + --body-service-details-scope-of-work string Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field. + -h, --help help for handle-smart-hand-cage-cleanup-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cage-escort-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cage-escort-order.md new file mode 100644 index 0000000..a0c882e --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-cage-escort-order.md @@ -0,0 +1,54 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-cage-escort-order + +Request a patch cable to be moved between devices + +### Synopsis + +This API is used to request a patch cable to be moved between devices + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-cage-escort-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-duration-visit string body-service-details-duration-visit + --body-service-details-open-cabinet-for-visitor Open the Cabinet for the Visitor? + --body-service-details-scope-of-work string Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field. + --body-service-details-supervision-req-for-visitor Supervision Required For the Visitor? + --body-service-details-work-visit-order-number string Work Visit Order Number + -h, --help help for handle-smart-hand-cage-escort-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-locate-package-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-locate-package-order.md new file mode 100644 index 0000000..d7f2634 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-locate-package-order.md @@ -0,0 +1,54 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-locate-package-order + +Get the location of your package(s) at an IBX. + +### Synopsis + +This API is used to get the location of your package(s) at an IBX. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-locate-package-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-package-description string Package Description + --body-service-details-possible-location string Possible Location + --body-service-details-scope-of-work string Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field. + --body-service-details-shipment-order-number string Inbound Shipment Order Number + --body-service-details-tracking-number string Tracking Number + -h, --help help for handle-smart-hand-locate-package-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-move-jumper-cable-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-move-jumper-cable-order.md new file mode 100644 index 0000000..2e42e74 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-move-jumper-cable-order.md @@ -0,0 +1,54 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-move-jumper-cable-order + +This API is used to request a patch cable to be moved between devices. + +### Synopsis + +This API is used to request a patch cable to be moved between devices. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-move-jumper-cable-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-cable-id string Enter Cable ID or ‘None’ if not applicable. This field is mandatory if 'Quantity' is 1. + --body-service-details-current-device-details string body-service-details-current-device-details (JSON) + --body-service-details-new-device-details string body-service-details-new-device-details (JSON) + --body-service-details-quantity string body-service-details-quantity + --body-service-details-scope-of-work string Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field. + -h, --help help for handle-smart-hand-move-jumper-cable-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-order.md new file mode 100644 index 0000000..6a1a3b7 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-order.md @@ -0,0 +1,59 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-order + +Request equipment installation per your specifications by an IBX Technician + +### Synopsis + +Request equipment installation per your specifications by an IBX Technician + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-device-location string Device Location + --body-service-details-elevation-drawing-attached Elevation drawing attached? + --body-service-details-installation-point string Installation Point + --body-service-details-installed-equipment-photo-required Installed Equipment Photo Required? + --body-service-details-mount-hardware-included Mount hardware included? + --body-service-details-need-support-from-a-submarine-cable-station-engineer This flag is only applicable to Submarine Cable IBXs + --body-service-details-patch-devices Patch Devices? + --body-service-details-patching-info string Patching info + --body-service-details-power-it-on Power it on? + --body-service-details-scope-of-work string Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field. + -h, --help help for handle-smart-hand-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-others-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-others-order.md new file mode 100644 index 0000000..9f67044 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-others-order.md @@ -0,0 +1,50 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-others-order + +Request a Smart Hands order not listed in catalogue + +### Synopsis + +This API is used to request a Smart Hands order not listed in catalogue + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-others-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-scope-of-work string Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field. + -h, --help help for handle-smart-hand-others-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-patch-cable-install-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-patch-cable-install-order.md new file mode 100644 index 0000000..b7bf366 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-patch-cable-install-order.md @@ -0,0 +1,50 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-patch-cable-install-order + +Request installation of a cross connect patch cable by an IBX Technician. + +### Synopsis + +Request installation of a cross connect patch cable by an IBX Technician. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-patch-cable-install-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-cross-connects string body-service-details-cross-connects (JSON array) + -h, --help help for handle-smart-hand-patch-cable-install-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-patch-cable-removal-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-patch-cable-removal-order.md new file mode 100644 index 0000000..5e67de3 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-patch-cable-removal-order.md @@ -0,0 +1,50 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-patch-cable-removal-order + +Request removal of a cross connect cable by an IBX Technician. + +### Synopsis + +Request removal of a cross connect cable by an IBX Technician. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-patch-cable-removal-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-cross-connects string body-service-details-cross-connects (JSON array) + -h, --help help for handle-smart-hand-patch-cable-removal-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-pictures-document-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-pictures-document-order.md new file mode 100644 index 0000000..a5219c7 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-pictures-document-order.md @@ -0,0 +1,54 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-pictures-document-order + +Request an IBX Technician to provide cage-related pictures or documentation. + +### Synopsis + +Request an IBX Technician to provide cage-related pictures or documentation. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-pictures-document-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-camera-provided-by string body-service-details-camera-provided-by + --body-service-details-description string Descrption of the Photo/Document. If documentOnly is false, this field is mandatory. + --body-service-details-document-only Do you need documents or pictures? Set true if you need documents. + --body-service-details-scope-of-work string Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field. + --body-service-details-specific-date-and-time Would you like to request a specific date and time? If true, Scheduling should not be STANDARD. If documentOnly is false, this field is mandatory. + -h, --help help for handle-smart-hand-pictures-document-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-run-jumper-cable-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-run-jumper-cable-order.md new file mode 100644 index 0000000..de9b1e8 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-run-jumper-cable-order.md @@ -0,0 +1,57 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-run-jumper-cable-order + +This API is used to request a jumper cable to be ran between devices. + +### Synopsis + +This API is used to request a jumper cable to be ran between devices. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-run-jumper-cable-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-cable-id string Cable ID + --body-service-details-connector string body-service-details-connector + --body-service-details-device-details string body-service-details-device-details (JSON array) + --body-service-details-jumper-type string body-service-details-jumper-type + --body-service-details-media-type string body-service-details-media-type + --body-service-details-provide-tx-rx-light-levels Provide Tx/Rx Light Levels + --body-service-details-quantity string body-service-details-quantity + --body-service-details-scope-of-work string Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field. + -h, --help help for handle-smart-hand-run-jumper-cable-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-shipment-unpack-order.md b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-shipment-unpack-order.md new file mode 100644 index 0000000..1c970f7 --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_handle-smart-hand-shipment-unpack-order.md @@ -0,0 +1,53 @@ +## equinix smarthandsv1 smarthands handle-smart-hand-shipment-unpack-order + +Request inbound shipment unpacking and packaging disposal. + +### Synopsis + +This API is used to request inbound shipment unpacking and packaging disposal. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands handle-smart-hand-shipment-unpack-order [flags] +``` + +### Options + +``` + --authorization string authorization field + --body-additional-properties string body-additional-properties (JSON) + --body-attachments string Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. (JSON array) + --body-contacts string Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. (JSON array) + --body-customer-reference-number string You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page. + --body-ibx-location-additional-properties string body-ibx-location-additional-properties (JSON) + --body-ibx-location-cages string body-ibx-location-cages (JSON array) + --body-ibx-location-ibx string body-ibx-location-ibx + --body-purchase-order-additional-properties string body-purchase-order-additional-properties (JSON) + --body-purchase-order-number string Purchase Order Number + --body-purchase-order-purchase-order-type string body-purchase-order-purchase-order-type + --body-schedule-additional-properties string body-schedule-additional-properties (JSON) + --body-schedule-requested-completion-date string body-schedule-requested-completion-date (JSON) + --body-schedule-requested-start-date string body-schedule-requested-start-date (JSON) + --body-schedule-schedule-type string body-schedule-schedule-type + --body-service-details-additional-properties string body-service-details-additional-properties (JSON) + --body-service-details-copy-of-packing-slip-needed Copy of Packaging Slip Needed? + --body-service-details-discard-shipment-material Discard Shipment Material? + --body-service-details-inbound-shipment-order-number string Inbound Shipment Order Number + --body-service-details-scope-of-work string Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field. + -h, --help help for handle-smart-hand-shipment-unpack-order + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_smarthandsv1_smarthands_smart-hand-types.md b/docs/equinix_smarthandsv1_smarthands_smart-hand-types.md new file mode 100644 index 0000000..c572f7d --- /dev/null +++ b/docs/equinix_smarthandsv1_smarthands_smart-hand-types.md @@ -0,0 +1,34 @@ +## equinix smarthandsv1 smarthands smart-hand-types + +All supported smart hands types API. + +### Synopsis + +Smart Hands Types API provides all types of supported smart hands. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix smarthandsv1 smarthands smart-hand-types [flags] +``` + +### Options + +``` + --authorization string authorization field + -h, --help help for smart-hand-types + --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 smarthandsv1 smarthands](equinix_smarthandsv1_smarthands.md) - Manage smarthands resources + diff --git a/docs/equinix_stsv1alpha.md b/docs/equinix_stsv1alpha.md new file mode 100644 index 0000000..3c3cfed --- /dev/null +++ b/docs/equinix_stsv1alpha.md @@ -0,0 +1,30 @@ +## equinix stsv1alpha + +Manage Equinix stsv1alpha resources + +### Synopsis + +Commands for managing Equinix stsv1alpha resources. + +The stsv1alpha commands are dynamically generated based on the stsv1alpha API client, +providing access to all available API services. + +### Options + +``` + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") + -h, --help help for stsv1alpha +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) +``` + +### SEE ALSO + +* [equinix](equinix.md) - Equinix CLI +* [equinix stsv1alpha use](equinix_stsv1alpha_use.md) - Manage use resources + diff --git a/docs/equinix_stsv1alpha_use.md b/docs/equinix_stsv1alpha_use.md new file mode 100644 index 0000000..5c72e7b --- /dev/null +++ b/docs/equinix_stsv1alpha_use.md @@ -0,0 +1,27 @@ +## equinix stsv1alpha use + +Manage use resources + +### Synopsis + +Commands for managing use resources in the API + +### Options + +``` + -h, --help help for use +``` + +### 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 stsv1alpha](equinix_stsv1alpha.md) - Manage Equinix stsv1alpha resources +* [equinix stsv1alpha use use-token-post](equinix_stsv1alpha_use_use-token-post.md) - Method for UseTokenPost + diff --git a/docs/equinix_stsv1alpha_use_use-token-post.md b/docs/equinix_stsv1alpha_use_use-token-post.md new file mode 100644 index 0000000..81a3940 --- /dev/null +++ b/docs/equinix_stsv1alpha_use_use-token-post.md @@ -0,0 +1,37 @@ +## equinix stsv1alpha use use-token-post + +Method for UseTokenPost + +### Synopsis + +An OAuth 2.0 token endpoint supporting RFC 8693 token exchange, used to exchange an OIDC ID token issued by a trusted OIDC provider to a trusted client for an access token that can be used access other Equinix product APIs. + +Use --request flag to provide optional JSON payload fields. + +``` +equinix stsv1alpha use use-token-post [flags] +``` + +### Options + +``` + --grant-type string grant-type field + -h, --help help for use-token-post + --request string JSON payload for additional optional fields not exposed as flags + --scope string scope field + --subject-token string subject-token field + --subject-token-type string subject-token-type 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 stsv1alpha use](equinix_stsv1alpha_use.md) - Manage use resources +