Class API

constructor

• new API(client): FlexibleIP.v1alpha1.API

• Parameters

  • client: Client

  Returns FlexibleIP.v1alpha1.API

Static ReadonlyLOCALITIES

attachFlexibleIP

• attachFlexibleIP(request): Promise<AttachFlexibleIPsResponse>

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

  Parameters

  • request: Readonly<AttachFlexibleIPRequest>

    The request AttachFlexibleIPRequest

  Returns Promise<AttachFlexibleIPsResponse>

  A Promise of AttachFlexibleIPsResponse

createFlexibleIP

• createFlexibleIP(request): Promise<FlexibleIP>

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

  Parameters

  • request: Readonly<CreateFlexibleIPRequest>

    The request CreateFlexibleIPRequest

  Returns Promise<FlexibleIP>

  A Promise of FlexibleIP

deleteFlexibleIP

• deleteFlexibleIP(request): Promise<void>

• 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.

  Parameters

  • request: Readonly<DeleteFlexibleIPRequest>

    The request DeleteFlexibleIPRequest

  Returns Promise<void>

deleteMACAddr

• deleteMACAddr(request): Promise<void>

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

  Parameters

  • request: Readonly<DeleteMACAddrRequest>

    The request DeleteMACAddrRequest

  Returns Promise<void>

detachFlexibleIP

• detachFlexibleIP(request): Promise<DetachFlexibleIPsResponse>

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

  Parameters

  • request: Readonly<DetachFlexibleIPRequest>

    The request DetachFlexibleIPRequest

  Returns Promise<DetachFlexibleIPsResponse>

  A Promise of DetachFlexibleIPsResponse

duplicateMACAddr

• duplicateMACAddr(request): Promise<FlexibleIP>

• 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.

  Parameters

  • request: Readonly<DuplicateMACAddrRequest>

    The request DuplicateMACAddrRequest

  Returns Promise<FlexibleIP>

  A Promise of FlexibleIP

generateMACAddr

• generateMACAddr(request): Promise<FlexibleIP>

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

  Parameters

  • request: Readonly<GenerateMACAddrRequest>

    The request GenerateMACAddrRequest

  Returns Promise<FlexibleIP>

  A Promise of FlexibleIP

getFlexibleIP

• getFlexibleIP(request): Promise<FlexibleIP>

• 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.

  Parameters

  • request: Readonly<GetFlexibleIPRequest>

    The request GetFlexibleIPRequest

  Returns Promise<FlexibleIP>

  A Promise of FlexibleIP

listFlexibleIPs

• listFlexibleIPs(request?): Promise<ListFlexibleIPsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<FlexibleIP[], void, void>);
      all: (() => Promise<FlexibleIP[]>);
  }

• List flexible IPs. List all flexible IPs within a given zone.

  Parameters

  • request: Readonly<FlexibleIP.v1alpha1.ListFlexibleIPsRequest> = {}

    The request ListFlexibleIPsRequest

  Returns Promise<ListFlexibleIPsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<FlexibleIP[], void, void>);
      all: (() => Promise<FlexibleIP[]>);
  }

  A Promise of ListFlexibleIPsResponse

moveMACAddr

• moveMACAddr(request): Promise<FlexibleIP>

• 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.

  Parameters

  • request: Readonly<MoveMACAddrRequest>

    The request MoveMACAddrRequest

  Returns Promise<FlexibleIP>

  A Promise of FlexibleIP

updateFlexibleIP

• updateFlexibleIP(request): Promise<FlexibleIP>

• 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.

  Parameters

  • request: Readonly<UpdateFlexibleIPRequest>

    The request UpdateFlexibleIPRequest

  Returns Promise<FlexibleIP>

  A Promise of FlexibleIP

waitForFlexibleIP

• waitForFlexibleIP(request, options?): Promise<FlexibleIP>

• Waits for FlexibleIP to be in a final state.

  Parameters

  • request: Readonly<GetFlexibleIPRequest>

    The request GetFlexibleIPRequest
  • Optionaloptions: Readonly<WaitForOptions<FlexibleIP>>

    The waiting options

  Returns Promise<FlexibleIP>

  A Promise of FlexibleIP