Copy page

Commands

Documentation for `scw fip`

This API allows you to manage your Elastic Metal servers' flexible public IP addresses.

Flexible IP management commands

A flexible IP can be attached to any Elastic Metal server within the same zone. Multiple flexible IPs can be attached to a server.

Attach an existing flexible IP to a server

Attach an existing flexible IP to a specified Elastic Metal server.

Usage:

Code
scw fip ip attach [arg=value ...]

Arguments:

Name	Description	Argument Specifications
fips-ids.{index}	List of flexible IP IDs to attach to a server	Required
server-id	ID of the server on which to attach the flexible IPs	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, nl-ams-2, pl-waw-2, pl-waw-3

Create a new flexible IP

Generate a new flexible IP within a given zone, specifying its configuration including Project ID and description.

Usage:

Code
scw fip ip create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
project-id	Project ID to use. If none is passed the default project ID will be used
description	Flexible IP description (max. of 255 characters)
tags.{index}	Tags to associate to the flexible IP
server-id	ID of the server to which the newly created flexible IP will be attached.
reverse	Value of the reverse DNS
is-ipv6	Defines whether the flexible IP has an IPv6 address.
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, nl-ams-2, pl-waw-2, pl-waw-3

Delete an existing flexible IP

Delete an existing flexible IP, specified by its ID and zone. Note that deleting a flexible IP is permanent and cannot be undone.

Usage:

Code
scw fip ip delete <fip-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
fip-id	ID of the flexible IP to delete	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, nl-ams-2, pl-waw-2, pl-waw-3

Detach an existing flexible IP from a server

Detach an existing flexible IP from a specified Elastic Metal server.

Usage:

Code
scw fip ip detach [arg=value ...]

Arguments:

Name	Description	Argument Specifications
fips-ids.{index}	List of flexible IP IDs to detach from a server. Multiple IDs can be provided. Note that flexible IPs must belong to the same MAC group.	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, nl-ams-2, pl-waw-2, pl-waw-3

Get an existing flexible IP

Retrieve information about an existing flexible IP, specified by its ID and zone. Its full details, including Project ID, description and status, are returned in the response object.

Usage:

Code
scw fip ip get <fip-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
fip-id	ID of the flexible IP	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, nl-ams-2, pl-waw-2, pl-waw-3

List flexible IPs

List all flexible IPs within a given zone.

Usage:

Code
scw fip ip list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Sort order of the returned flexible IPs	One of: created_at_asc, created_at_desc
tags.{index}	Filter by tag, only flexible IPs with one or more matching tags will be returned
status.{index}	Filter by status, only flexible IPs with this status will be returned	One of: unknown, ready, updating, attached, error, detaching, locked
server-ids.{index}	Filter by server IDs, only flexible IPs with these server IDs will be returned
project-id	Filter by Project ID, only flexible IPs from this Project will be returned
organization-id	Filter by Organization ID, only flexible IPs from this Organization will be returned
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, nl-ams-2, pl-waw-2, pl-waw-3, all

Update an existing flexible IP

Update the parameters of an existing flexible IP, specified by its ID and zone. These parameters include tags and description.

Usage:

Code
scw fip ip update <fip-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
fip-id	ID of the flexible IP to update	Required
description	Flexible IP description (max. 255 characters)
tags.{index}	Tags associated with the flexible IP
reverse	Value of the reverse DNS
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, nl-ams-2, pl-waw-2, pl-waw-3

MAC address management commands

MAC address management commands.

Generate a virtual MAC address on an existing flexible IP

Generate a virtual MAC (Media Access Control) address on an existing flexible IP.

Usage:

Code
scw fip mac create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
fip-id	ID of the flexible IP for which to generate a virtual MAC	Required
mac-type	TODO	Required One of: unknown_type, vmware, xen, kvm
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, nl-ams-2, pl-waw-2, pl-waw-3

Detach a given virtual MAC address from an existing flexible IP

Detach a given MAC (Media Access Control) address from an existing flexible IP.

Usage:

Code
scw fip mac delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
fip-id	ID of the flexible IP from which to delete the virtual MAC	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, nl-ams-2, pl-waw-2, pl-waw-3

Duplicate a virtual MAC address to another flexible IP

Duplicate a virtual MAC address from a given flexible IP to another flexible IP attached to the same server.

Usage:

Code
scw fip mac duplicate [arg=value ...]

Arguments:

Name	Description	Argument Specifications
fip-id	ID of the flexible IP on which to duplicate the virtual MAC	Required
duplicate-from-fip-id	ID of the flexible IP to duplicate the Virtual MAC from	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, nl-ams-2, pl-waw-2, pl-waw-3

Relocate an existing virtual MAC address to a different flexible IP

Relocate a virtual MAC (Media Access Control) address from an existing flexible IP to a different flexible IP.

Usage:

Code
scw fip mac move [arg=value ...]

Arguments:

Name	Description	Argument Specifications
fip-id		Required
dst-fip-id
zone	Zone to target. If none is passed will use default zone from the config	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, nl-ams-2, pl-waw-2, pl-waw-3