Module: NetworkApi

Defined in:
lib/pnap_network_api/api_error.rb,
lib/pnap_network_api.rb,
lib/pnap_network_api/version.rb,
lib/pnap_network_api/api_client.rb,
lib/pnap_network_api/models/error.rb,
lib/pnap_network_api/configuration.rb,
lib/pnap_network_api/models/asn_details.rb,
lib/pnap_network_api/models/bgp_peer_group.rb,
lib/pnap_network_api/models/public_network.rb,
lib/pnap_network_api/models/bgp_ipv4_prefix.rb,
lib/pnap_network_api/models/private_network.rb,
lib/pnap_network_api/api/bgp_peer_groups_api.rb,
lib/pnap_network_api/api/public_networks_api.rb,
lib/pnap_network_api/api/private_networks_api.rb,
lib/pnap_network_api/models/network_membership.rb,
lib/pnap_network_api/models/bgp_peer_group_patch.rb,
lib/pnap_network_api/models/bgp_peer_group_create.rb,
lib/pnap_network_api/models/public_network_create.rb,
lib/pnap_network_api/models/public_network_modify.rb,
lib/pnap_network_api/models/private_network_create.rb,
lib/pnap_network_api/models/private_network_modify.rb,
lib/pnap_network_api/models/private_network_server.rb,
lib/pnap_network_api/models/public_network_ip_block.rb,
lib/pnap_network_api/models/public_network_ip_block_create.rb

Overview

#Networks API

#Create, list, edit and delete public/private networks with the Network API. Use public networks to place multiple servers on the same network or VLAN. Assign new servers with IP addresses from the same CIDR range. Use private networks to avoid unnecessary egress data charges. Model your networks according to your business needs.

<span class=‘pnap-api-knowledge-base-link’> Helpful knowledge base articles are available for <a href=‘phoenixnap.com/kb/bmc-server-management-via-api#multi-private-backend-network-api’ target=‘_blank’>multi-private backend networks</a>, <a href=‘phoenixnap.com/kb/bmc-server-management-via-api#ftoc-heading-15’ target=‘_blank’>public networks</a> and <a href=‘phoenixnap.com/kb/border-gateway-protocol-bmc’ target=‘_blank’>border gateway protocol peer groups</a>. </span>

All URLs are relative to (https://api.phoenixnap.com/networks/v1/)

The version of the OpenAPI document: 1.0 Contact: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 7.2.0

Defined Under Namespace

Classes: ApiClient, ApiError, AsnDetails, BGPPeerGroupsApi, BgpIPv4Prefix, BgpPeerGroup, BgpPeerGroupCreate, BgpPeerGroupPatch, Configuration, Error, NetworkMembership, PrivateNetwork, PrivateNetworkCreate, PrivateNetworkModify, PrivateNetworkServer, PrivateNetworksApi, PublicNetwork, PublicNetworkCreate, PublicNetworkIpBlock, PublicNetworkIpBlockCreate, PublicNetworkModify, PublicNetworksApi

Constant Summary collapse

VERSION = 
get_version()

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

NetworkApi.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



50
51
52
53
54
55
56
 
# File 'lib/pnap_network_api.rb', line 50

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end