Class PrivateNetworkAPI

constructor

• new PrivateNetworkAPI(client): BareMetal.v3.PrivateNetworkAPI

• Parameters

  • client: Client

  Returns BareMetal.v3.PrivateNetworkAPI

Static ReadonlyLOCALITIES

addServerPrivateNetwork

• addServerPrivateNetwork(request): Promise<BareMetal.v3.ServerPrivateNetwork>

• Add a server to a Private Network. Add an Elastic Metal server to a Private Network.

  Parameters

  • request: Readonly<BareMetal.v3.PrivateNetworkApiAddServerPrivateNetworkRequest>

    The request PrivateNetworkApiAddServerPrivateNetworkRequest

  Returns Promise<BareMetal.v3.ServerPrivateNetwork>

  A Promise of ServerPrivateNetwork

deleteServerPrivateNetwork

• deleteServerPrivateNetwork(request): Promise<void>

• Delete a Private Network.

  Parameters

  • request: Readonly<BareMetal.v3.PrivateNetworkApiDeleteServerPrivateNetworkRequest>

    The request PrivateNetworkApiDeleteServerPrivateNetworkRequest

  Returns Promise<void>

listServerPrivateNetworks

• listServerPrivateNetworks(request?): Promise<BareMetal.v3.ListServerPrivateNetworksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<BareMetal.v3.ServerPrivateNetwork[], void, void>);
      all: (() => Promise<BareMetal.v3.ServerPrivateNetwork[]>);
  }

• List the Private Networks of a server. List the Private Networks of an Elastic Metal server.

  Parameters

  • request: Readonly<BareMetal.v3.PrivateNetworkApiListServerPrivateNetworksRequest> = {}

    The request PrivateNetworkApiListServerPrivateNetworksRequest

  Returns Promise<BareMetal.v3.ListServerPrivateNetworksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<BareMetal.v3.ServerPrivateNetwork[], void, void>);
      all: (() => Promise<BareMetal.v3.ServerPrivateNetwork[]>);
  }

  A Promise of ListServerPrivateNetworksResponse

setServerPrivateNetworks

• setServerPrivateNetworks(request): Promise<BareMetal.v3.SetServerPrivateNetworksResponse>

• Set multiple Private Networks on a server. Configure multiple Private Networks on an Elastic Metal server.

  Parameters

  • request: Readonly<BareMetal.v3.PrivateNetworkApiSetServerPrivateNetworksRequest>

    The request PrivateNetworkApiSetServerPrivateNetworksRequest

  Returns Promise<BareMetal.v3.SetServerPrivateNetworksResponse>

  A Promise of SetServerPrivateNetworksResponse