feat: Added support for Metal Interconnections (#321)

## Description: ## What this PR does / why we need it: Added support for metal interconnections ## What issues has this PR fixed? #307
equinix · Nov 9, 2023 · cd40bb0 · cd40bb0
2 parents 2554db1 + 74a5014
commit cd40bb0
Show file tree

Hide file tree

Showing 13 changed files with 583 additions and 0 deletions.
diff --git a/cmd/cli.go b/cmd/cli.go
@@ -15,6 +15,7 @@ import (
 	"github.com/equinix/metal-cli/internal/gateway"
 	"github.com/equinix/metal-cli/internal/hardware"
 	initPkg "github.com/equinix/metal-cli/internal/init"
+	"github.com/equinix/metal-cli/internal/interconnections"
 	"github.com/equinix/metal-cli/internal/ips"
 	"github.com/equinix/metal-cli/internal/metros"
 	"github.com/equinix/metal-cli/internal/organizations"
@@ -93,5 +94,6 @@ func (cli *Cli) RegisterCommands(client *root.Client) {
 		twofa.NewClient(client, cli.Outputer).NewCommand(),
 		gateway.NewClient(client, cli.Outputer).NewCommand(),
 		ports.NewClient(client, cli.Outputer).NewCommand(),
+		interconnections.NewClient(client, cli.Outputer).NewCommand(),
 	)
 }
diff --git a/docs/metal.md b/docs/metal.md
@@ -36,6 +36,7 @@ Command line interface for Equinix Metal
 * [metal gateway](metal_gateway.md)	 - Metal Gateway operations: create, delete, and retrieve.
 * [metal hardware-reservation](metal_hardware-reservation.md)	 - Hardware reservation operations: get, move.
 * [metal init](metal_init.md)	 - Create a configuration file.
+* [metal interconnections](metal_interconnections.md)	 - interconnections operations: create, get, update, delete
 * [metal ip](metal_ip.md)	 - IP address, reservations, and assignment operations: assign, unassign, remove, available, request and get.
 * [metal metros](metal_metros.md)	 - Metro operations: get.
 * [metal operating-systems](metal_operating-systems.md)	 - Operating system operations: get.

diff --git a/docs/metal_interconnections.md b/docs/metal_interconnections.md
@@ -0,0 +1,37 @@
+## metal interconnections
+
+interconnections operations: create, get, update, delete
+
+### Synopsis
+
+Get information on Metro locations. For more information on https://deploy.equinix.com/developers/docs/metal/interconnections.
+
+### Options
+
+```
+  -h, --help   help for interconnections
+```
+
+### Options inherited from parent commands
+
+```
+      --config string         Path to JSON or YAML configuration file
+      --exclude strings       Comma separated Href references to collapse in results, may be dotted three levels deep
+      --filter stringArray    Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
+      --http-header strings   Headers to add to requests (in format key=value)
+      --include strings       Comma separated Href references to expand in results, may be dotted three levels deep
+  -o, --output string         Output format (*table, json, yaml). env output formats are (*sh, terraform, capp).
+      --search string         Search keyword for use in 'get' actions. Search is not supported by all resources.
+      --sort-by string        Sort fields for use in 'get' actions. Sort is not supported by all resources.
+      --sort-dir string       Sort field direction for use in 'get' actions. Sort is not supported by all resources.
+      --token string          Metal API Token (METAL_AUTH_TOKEN)
+```
+
+### SEE ALSO
+
+* [metal](metal.md)	 - Command line interface for Equinix Metal
+* [metal interconnections create](metal_interconnections_create.md)	 - Creates an interconnection.
+* [metal interconnections delete](metal_interconnections_delete.md)	 - Deletes a interconnection.
+* [metal interconnections get](metal_interconnections_get.md)	 - Retrieves interconnections for the current user, an organization, a project or the details of a specific interconnection.
+* [metal interconnections update](metal_interconnections_update.md)	 - Updates a connection.
+
diff --git a/docs/metal_interconnections_create.md b/docs/metal_interconnections_create.md
@@ -0,0 +1,55 @@
+## metal interconnections create
+
+Creates an interconnection.
+
+### Synopsis
+
+Creates a new interconnection as per the organization ID or project ID 
+
+```
+metal interconnections create -n <name> [-m <metro>] [-r <redundancy> ] [-t <type> ] [-p <project_id> ] | [-O <organization_id> ] [flags]
+```
+
+### Examples
+
+```
+  # Creates a new interconnection named "it-interconnection":
+  metal interconnections create -n <name> [-m <metro>] [-r <redundancy>] [-t "dedicated" ] [-p <project_id>] | [-O <organization_id>]
+
+  metal interconnections create -n <name> [-m <metro>] [-r <redundancy>] [-t "shared" ] [-p <project_id>] | [-O <organization_id>] -T <service_token_type>
+
+  metal interconnections create -n <name> [-m <metro>] [-r <redundancy>] [-t "shared" ] [-p <project_id>] | [-O <organization_id>] -T <service_token_type> -v <vrfs>
+```
+
+### Options
+
+```
+  -h, --help                    help for create
+  -m, --metro string            metro in the interconnection
+  -n, --name string             Name of the interconnection
+  -O, --organizationID string   Org ID
+  -p, --projectID string        project ID
+  -r, --redundancy string       Website URL of the organization.
+  -t, --type string             type of of interconnection.
+  -v, --vrfs strings            Return only the specified vrfs.
+```
+
+### Options inherited from parent commands
+
+```
+      --config string         Path to JSON or YAML configuration file
+      --exclude strings       Comma separated Href references to collapse in results, may be dotted three levels deep
+      --filter stringArray    Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
+      --http-header strings   Headers to add to requests (in format key=value)
+      --include strings       Comma separated Href references to expand in results, may be dotted three levels deep
+  -o, --output string         Output format (*table, json, yaml). env output formats are (*sh, terraform, capp).
+      --search string         Search keyword for use in 'get' actions. Search is not supported by all resources.
+      --sort-by string        Sort fields for use in 'get' actions. Sort is not supported by all resources.
+      --sort-dir string       Sort field direction for use in 'get' actions. Sort is not supported by all resources.
+      --token string          Metal API Token (METAL_AUTH_TOKEN)
+```
+
+### SEE ALSO
+
+* [metal interconnections](metal_interconnections.md)	 - interconnections operations: create, get, update, delete
+
diff --git a/docs/metal_interconnections_delete.md b/docs/metal_interconnections_delete.md
@@ -0,0 +1,45 @@
+## metal interconnections delete
+
+Deletes a interconnection.
+
+### Synopsis
+
+Deletes the specified interconnection.
+
+```
+metal interconnections delete -i <connection_id>  [flags]
+```
+
+### Examples
+
+```
+  # Deletes the specified interconnection:
+  metal interconnections delete -i 7ec86e23-8dcf-48ed-bd9b-c25c20958277
+```
+
+### Options
+
+```
+  -h, --help        help for delete
+  -i, --id string   The UUID of the interconnection.
+```
+
+### Options inherited from parent commands
+
+```
+      --config string         Path to JSON or YAML configuration file
+      --exclude strings       Comma separated Href references to collapse in results, may be dotted three levels deep
+      --filter stringArray    Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
+      --http-header strings   Headers to add to requests (in format key=value)
+      --include strings       Comma separated Href references to expand in results, may be dotted three levels deep
+  -o, --output string         Output format (*table, json, yaml). env output formats are (*sh, terraform, capp).
+      --search string         Search keyword for use in 'get' actions. Search is not supported by all resources.
+      --sort-by string        Sort fields for use in 'get' actions. Sort is not supported by all resources.
+      --sort-dir string       Sort field direction for use in 'get' actions. Sort is not supported by all resources.
+      --token string          Metal API Token (METAL_AUTH_TOKEN)
+```
+
+### SEE ALSO
+
+* [metal interconnections](metal_interconnections.md)	 - interconnections operations: create, get, update, delete
+
diff --git a/docs/metal_interconnections_get.md b/docs/metal_interconnections_get.md
@@ -0,0 +1,55 @@
+## metal interconnections get
+
+Retrieves interconnections for the current user, an organization, a project or the details of a specific interconnection.
+
+### Synopsis
+
+Retrieves interconnections for the current user, an organization, a project or the details of a specific interconnection.
+
+```
+metal interconnections get [flags]
+```
+
+### Examples
+
+```
+  # Retrieve all interconnections of a current user::
+  
+  # Retrieve the details of a specific interconnection:
+  metal interconnections get -i e9a969b3-8911-4667-9d99-57cd3dd4ef6f
+
+  # Retrieve all the interconnection of an organization:
+  metal interconnections get -O c079178c-9557-48f2-9ce7-cfb927b81928
+
+  # Retrieve all interconnection of a project:
+  metal interconnections get -p 1867ee8f-6a11-470a-9505-952d6a324040 
+```
+
+### Options
+
+```
+  -i, --connID string           UUID of the interconnection
+  -h, --help                    help for get
+  -O, --organizationID string   UUID of the organization
+  -p, --projectID string        Project ID (METAL_PROJECT_ID)
+```
+
+### Options inherited from parent commands
+
+```
+      --config string         Path to JSON or YAML configuration file
+      --exclude strings       Comma separated Href references to collapse in results, may be dotted three levels deep
+      --filter stringArray    Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
+      --http-header strings   Headers to add to requests (in format key=value)
+      --include strings       Comma separated Href references to expand in results, may be dotted three levels deep
+  -o, --output string         Output format (*table, json, yaml). env output formats are (*sh, terraform, capp).
+      --search string         Search keyword for use in 'get' actions. Search is not supported by all resources.
+      --sort-by string        Sort fields for use in 'get' actions. Sort is not supported by all resources.
+      --sort-dir string       Sort field direction for use in 'get' actions. Sort is not supported by all resources.
+      --token string          Metal API Token (METAL_AUTH_TOKEN)
+```
+
+### SEE ALSO
+
+* [metal interconnections](metal_interconnections.md)	 - interconnections operations: create, get, update, delete
+
diff --git a/docs/metal_interconnections_update.md b/docs/metal_interconnections_update.md
@@ -0,0 +1,51 @@
+## metal interconnections update
+
+Updates a connection.
+
+### Synopsis
+
+Updates a specified connection.
+
+```
+metal interconnections update -i <connection_id> [flags]
+```
+
+### Examples
+
+```
+  # Updates a specified connection.:
+  metal interconnections update --id 30c15082-a06e-4c43-bfc3-252616b46eba -n [<name>] -d [<description>] -r [<'redundant'|'primary'>]-m [<standard|tunnel>] -e [<E-mail>] --tags="tag1,tag2"
+```
+
+### Options
+
+```
+  -e, --contactEmail string   adds or updates the Email
+  -d, --description string    Adds or updates the description for the interconnection.
+  -h, --help                  help for update
+  -i, --id string             The UUID of the interconnection.
+  -m, --mode string           Adds or updates the mode for the interconnection.
+  -n, --name string           The new name of the interconnection.
+  -r, --redundancy string     Updating from 'redundant' to 'primary' will remove a secondary port, while updating from 'primary' to 'redundant' will add one.
+  -t, --tags strings          Adds or updates the tags for the connection --tags="tag1,tag2".
+```
+
+### Options inherited from parent commands
+
+```
+      --config string         Path to JSON or YAML configuration file
+      --exclude strings       Comma separated Href references to collapse in results, may be dotted three levels deep
+      --filter stringArray    Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
+      --http-header strings   Headers to add to requests (in format key=value)
+      --include strings       Comma separated Href references to expand in results, may be dotted three levels deep
+  -o, --output string         Output format (*table, json, yaml). env output formats are (*sh, terraform, capp).
+      --search string         Search keyword for use in 'get' actions. Search is not supported by all resources.
+      --sort-by string        Sort fields for use in 'get' actions. Sort is not supported by all resources.
+      --sort-dir string       Sort field direction for use in 'get' actions. Sort is not supported by all resources.
+      --token string          Metal API Token (METAL_AUTH_TOKEN)
+```
+
+### SEE ALSO
+
+* [metal interconnections](metal_interconnections.md)	 - interconnections operations: create, get, update, delete
+
diff --git a/internal/interconnections/create.go b/internal/interconnections/create.go
@@ -0,0 +1,71 @@
+package interconnections
+
+import (
+	"context"
+	"fmt"
+
+	metal "github.com/equinix-labs/metal-go/metal/v1"
+	"github.com/spf13/cobra"
+)
+
+func (c *Client) Create() *cobra.Command {
+	var name, metro, redundancy, connType, projectID, organizationID string
+	var vrfs []string
+
+	createInterconnectionsCmd := &cobra.Command{
+		Use:   `create -n <name> [-m <metro>] [-r <redundancy> ] [-t <type> ] [-p <project_id> ] | [-O <organization_id> ]`,
+		Short: "Creates an interconnection.",
+		Long:  "Creates a new interconnection as per the organization ID or project ID ",
+		Example: `  # Creates a new interconnection named "it-interconnection":
+  metal interconnections create -n <name> [-m <metro>] [-r <redundancy>] [-t "dedicated" ] [-p <project_id>] | [-O <organization_id>]
+
+  metal interconnections create -n <name> [-m <metro>] [-r <redundancy>] [-t "shared" ] [-p <project_id>] | [-O <organization_id>] -T <service_token_type>
+
+  metal interconnections create -n <name> [-m <metro>] [-r <redundancy>] [-t "shared" ] [-p <project_id>] | [-O <organization_id>] -T <service_token_type> -v <vrfs>`,
+
+		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
+			var interconn *metal.Interconnection
+			var err error
+
+			createOrganizationInterconnectionRequest := metal.CreateOrganizationInterconnectionRequest{DedicatedPortCreateInput: metal.NewDedicatedPortCreateInput(metro, name, redundancy, metal.DedicatedPortCreateInputType(connType))}
+			if projectID != "" {
+
+				interconn, _, err = c.Service.CreateProjectInterconnection(context.Background(), projectID).CreateOrganizationInterconnectionRequest(createOrganizationInterconnectionRequest).Execute()
+				if err != nil {
+					return fmt.Errorf("could not create interconnections: %w", err)
+
+				}
+			} else if organizationID != "" {
+				interconn, _, err = c.Service.CreateOrganizationInterconnection(context.Background(), organizationID).CreateOrganizationInterconnectionRequest(createOrganizationInterconnectionRequest).Execute()
+				if err != nil {
+					return fmt.Errorf("could not create interconnections: %w", err)
+				}
+			} else {
+				return fmt.Errorf("Could you provide at least either of projectID OR organizationID")
+			}
+
+			data := make([][]string, 1)
+
+			data[0] = []string{interconn.GetId(), interconn.GetName(), string(interconn.GetType()), interconn.GetCreatedAt().String()}
+			header := []string{"ID", "Name", "Type", "Created"}
+
+			return c.Out.Output(interconn, header, &data)
+		},
+	}
+
+	createInterconnectionsCmd.Flags().StringVarP(&name, "name", "n", "", "Name of the interconnection")
+	createInterconnectionsCmd.Flags().StringVarP(&metro, "metro", "m", "", "metro in the interconnection")
+	createInterconnectionsCmd.Flags().StringVarP(&redundancy, "redundancy", "r", "", "Website URL of the organization.")
+	createInterconnectionsCmd.Flags().StringVarP(&connType, "type", "t", "", "type of of interconnection.")
+	// createInterconnectionsCmd.Flags().StringVarP(&connType, "serviceTokentype", "T", "", "service token type for interconnection either fabric OR Metal builds")
+	createInterconnectionsCmd.Flags().StringSliceVarP(&vrfs, "vrfs", "v", []string{}, "Return only the specified vrfs.")
+	createInterconnectionsCmd.Flags().StringVarP(&projectID, "projectID", "p", "", "project ID")
+	createInterconnectionsCmd.Flags().StringVarP(&organizationID, "organizationID", "O", "", "Org ID")
+
+	_ = createInterconnectionsCmd.MarkFlagRequired("name")
+	_ = createInterconnectionsCmd.MarkFlagRequired("metro")
+	_ = createInterconnectionsCmd.MarkFlagRequired("redundancy")
+	_ = createInterconnectionsCmd.MarkFlagRequired("type")
+	return createInterconnectionsCmd
+}
diff --git a/internal/interconnections/delete.go b/internal/interconnections/delete.go
@@ -0,0 +1,37 @@
+package interconnections
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+func (c *Client) Delete() *cobra.Command {
+	var connectionID string
+
+	deleteConnectionCmd := &cobra.Command{
+		Use:   `delete -i <connection_id> `,
+		Short: "Deletes a interconnection.",
+		Long:  "Deletes the specified interconnection.",
+		Example: `  # Deletes the specified interconnection:
+  metal interconnections delete -i 7ec86e23-8dcf-48ed-bd9b-c25c20958277`,
+
+		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.SilenceUsage = true
+
+			_, _, err := c.Service.DeleteInterconnection(context.Background(), connectionID).Execute()
+			if err != nil {
+				return err
+			}
+			fmt.Println("connection deletion initiated. Please check 'metal interconnections get -i", connectionID, "' for status")
+
+			return nil
+		},
+	}
+
+	deleteConnectionCmd.Flags().StringVarP(&connectionID, "id", "i", "", "The UUID of the interconnection.")
+	_ = deleteConnectionCmd.MarkFlagRequired("id")
+
+	return deleteConnectionCmd
+}