| Server IP : 78.140.185.180 / Your IP : 216.73.216.45 Web Server : LiteSpeed System : Linux cpanel13.v.fozzy.com 4.18.0-513.11.1.lve.el8.x86_64 #1 SMP Thu Jan 18 16:21:02 UTC 2024 x86_64 User : builderbox ( 1072) PHP Version : 7.3.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /home/builderbox/www/vendor/rackspace/php-opencloud/doc/_build/html/services/networking/ |
Upload File : |
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Networking v2 — php-opencloud 1.12.1 documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="top" title="php-opencloud 1.12.1 documentation" href="../../index.html"/>
<link rel="next" title="Networks" href="networks.html"/>
<link rel="prev" title="Zones" href="../monitoring/zones.html"/>
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="../../index.html" class="fa fa-home"> php-opencloud</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../autoscale/index.html">Auto Scale v2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../compute/index.html">Compute v2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../compute/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../compute/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../compute/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../compute/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Databases v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../database/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../dns/index.html">DNS v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../dns/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dns/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dns/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dns/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../identity/index.html">Identity v2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../identity/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../identity/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../identity/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../identity/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../image/index.html">Images v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../image/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../image/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../image/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../image/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../load-balancer/index.html">Load Balancer v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#further-links">Further Links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../monitoring/index.html">Monitoring v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#further-links">Further links</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Networking v2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="#further-links">Further links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../object-store/index.html">Object Store v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#further-links">Further links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../orchestration/index.html">Orchestration v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#further-links">Further links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../queues/index.html">Queues v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../queues/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../queues/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../queues/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../queues/index.html#further-links">Further links</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../volume/index.html">Volumes v1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../volume/index.html#setup">Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../volume/index.html#operations">Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../volume/index.html#glossary">Glossary</a></li>
<li class="toctree-l2"><a class="reference internal" href="../volume/index.html#further-links">Further links</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../debugging.html">Debugging</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../debugging.html#strategy-1-meaningful-exception-handling">Strategy 1: Meaningful exception handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../debugging.html#strategy-2-wire-logging">Strategy 2: Wire logging</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../caching-creds.html">Caching credentials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../caching-creds.html#filesystem-example">Filesystem example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../iterators.html">Iterators</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../iterators.html#common-behaviour">Common behaviour</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../iterators.html#very-important-note">Very important note</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../iterators.html#using-paginated-collections">Using paginated collections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../iterators.html#setting-up-a-paginatediterator">Setting up a PaginatedIterator</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../regions.html">Rackspace regions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../url-types.html">URL types</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../url-types.html#internalurl">internalURL</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../url-types.html#publicurl">publicURL</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../logging.html">Logging</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../logging.html#logger-injection">Logger injection</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../http-clients.html">HTTP Clients</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#default-http-headers">Default HTTP headers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#user-agents">User agents</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#other-functionality">Other functionality</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../auth.html">Authentication</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../auth.html#service-catalog">Service Catalog</a></li>
</ul>
</li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">php-opencloud</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> »</li>
<li>Networking v2</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/services/networking/index.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section" id="networking-v2">
<h1>Networking v2<a class="headerlink" href="#networking-v2" title="Permalink to this headline">¶</a></h1>
<div class="section" id="setup">
<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h2>
<div class="section" id="rackspace-setup">
<h3>Rackspace setup<a class="headerlink" href="#rackspace-setup" title="Permalink to this headline">¶</a></h3>
<p>The first step is to pass in your credentials and set up a client. For
Rackspace users, you will need your username and API key:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">OpenCloud\Rackspace</span><span class="p">;</span>
<span class="nv">$client</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Rackspace</span><span class="p">(</span><span class="nx">Rackspace</span><span class="o">::</span><span class="na">US_IDENTITY_ENDPOINT</span><span class="p">,</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'username'</span> <span class="o">=></span> <span class="s1">'{username}'</span><span class="p">,</span>
<span class="s1">'apiKey'</span> <span class="o">=></span> <span class="s1">'{apiKey}'</span><span class="p">,</span>
<span class="p">));</span>
</pre></div>
</div>
</div>
<div class="section" id="openstack-setup">
<h3>OpenStack setup<a class="headerlink" href="#openstack-setup" title="Permalink to this headline">¶</a></h3>
<p>If you’re an OpenStack user, you will also need to prove a few other
configuration parameters:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$client</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">OpenCloud\OpenStack</span><span class="p">(</span><span class="s1">'{keystoneUrl}'</span><span class="p">,</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'username'</span> <span class="o">=></span> <span class="s1">'{username}'</span><span class="p">,</span>
<span class="s1">'password'</span> <span class="o">=></span> <span class="s1">'{apiKey}'</span><span class="p">,</span>
<span class="s1">'tenantId'</span> <span class="o">=></span> <span class="s1">'{tenantId}'</span><span class="p">,</span>
<span class="p">));</span>
</pre></div>
</div>
</div>
<div class="section" id="networking-service">
<h3>Networking service<a class="headerlink" href="#networking-service" title="Permalink to this headline">¶</a></h3>
<p>Now to instantiate the Networking service:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$service</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">networkingService</span><span class="p">(</span><span class="s1">'{catalogName}'</span><span class="p">,</span> <span class="s1">'{region}'</span><span class="p">,</span> <span class="s1">'{urlType}'</span><span class="p">);</span>
</pre></div>
</div>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">{catalogName}</span></tt> is the name of the service as it appears in the service
catalog. OpenStack users <em>must</em> set this value. For Rackspace users, a
default will be provided if you pass in <tt class="docutils literal"><span class="pre">null</span></tt>.</li>
<li><tt class="docutils literal"><span class="pre">{region}</span></tt> is the region the service will operate in. For Rackspace
users, you can select one of the following from the <a class="reference external" href="/regions">supported regions page</a>.</li>
<li><tt class="docutils literal"><span class="pre">{urlType}</span></tt> is the <a class="reference external" href="/url-types">type of URL</a> to use, depending on which
endpoints your catalog provides. If omitted, it will default to the public
network.</li>
</ul>
</div>
</div>
<div class="section" id="operations">
<h2>Operations<a class="headerlink" href="#operations" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="networks.html">Networks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="networks.html#create-a-network">Create a network</a></li>
<li class="toctree-l2"><a class="reference internal" href="networks.html#create-multiple-networks">Create multiple networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="networks.html#list-networks">List networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="networks.html#get-a-network">Get a network</a></li>
<li class="toctree-l2"><a class="reference internal" href="networks.html#update-a-network">Update a network</a><ul>
<li class="toctree-l3"><a class="reference internal" href="networks.html#delete-a-network">Delete a network</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="subnets.html">Subnets</a><ul>
<li class="toctree-l2"><a class="reference internal" href="subnets.html#create-a-subnet">Create a subnet</a></li>
<li class="toctree-l2"><a class="reference internal" href="subnets.html#create-multiple-subnets">Create multiple subnets</a></li>
<li class="toctree-l2"><a class="reference internal" href="subnets.html#list-subnets">List subnets</a></li>
<li class="toctree-l2"><a class="reference internal" href="subnets.html#get-a-subnet">Get a subnet</a></li>
<li class="toctree-l2"><a class="reference internal" href="subnets.html#update-a-subnet">Update a subnet</a></li>
<li class="toctree-l2"><a class="reference internal" href="subnets.html#delete-a-subnet">Delete a subnet</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ports.html">Ports</a><ul>
<li class="toctree-l2"><a class="reference internal" href="ports.html#create-a-port">Create a port</a></li>
<li class="toctree-l2"><a class="reference internal" href="ports.html#create-multiple-ports">Create multiple ports</a></li>
<li class="toctree-l2"><a class="reference internal" href="ports.html#list-ports">List ports</a></li>
<li class="toctree-l2"><a class="reference internal" href="ports.html#get-a-port">Get a port</a></li>
<li class="toctree-l2"><a class="reference internal" href="ports.html#update-a-port">Update a port</a></li>
<li class="toctree-l2"><a class="reference internal" href="ports.html#delete-a-port">Delete a port</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="security-groups.html">Security Groups</a><ul>
<li class="toctree-l2"><a class="reference internal" href="security-groups.html#create-a-security-group">Create a security group</a></li>
<li class="toctree-l2"><a class="reference internal" href="security-groups.html#list-security-groups">List security groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="security-groups.html#get-a-security-group">Get a security group</a></li>
<li class="toctree-l2"><a class="reference internal" href="security-groups.html#delete-a-security-group">Delete a security group</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="security-group-rules.html">Security Group Rules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="security-group-rules.html#create-a-security-group-rule">Create a security group rule</a></li>
<li class="toctree-l2"><a class="reference internal" href="security-group-rules.html#list-security-group-rules">List security group rules</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="glossary">
<h2>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h2>
<dl class="glossary docutils">
<dt id="term-network">network</dt>
<dd>A network is an isolated virtual layer-2 broadcast domain that is typically
reserved for the tenant who created it unless you configure the network to
be shared. The network is the main entity in the Networking service. Ports
and subnets are always associated with a network.</dd>
<dt id="term-subnet">subnet</dt>
<dd>A subnet represents an IP address block that can be used to assign IP
addresses to virtual instances (such as servers created using the Compute
service). Each subnet must have a CIDR and must be associated with a network.</dd>
<dt id="term-port">port</dt>
<dd>A port represents a virtual switch port on a logical network switch.
Virtual instances (such as servers created using the Compute service)
attach their interfaces into ports. The port also defines the MAC address
and the IP address(es) to be assigned to the interfaces plugged into them.
When IP addresses are associated to a port, this also implies the port is
associated with a subet, as the IP address is taken from the allocation
pool for a specific subnet.</dd>
<dt id="term-security-group">security group</dt>
<dd>A security group is a named container for security group rules.</dd>
<dt id="term-security-group-rule">security group rule</dt>
<dd>A security group rule provides users the ability to specify the types of
traffic that are allowed to pass through to and from ports on a virtual
server instance.</dd>
</dl>
</div>
<div class="section" id="further-links">
<h2>Further links<a class="headerlink" href="#further-links" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="http://docs.rackspace.com/networks/api/v2/cn-gettingstarted/content/ch_preface.html">Getting Started Guide for the API</a></li>
<li><a class="reference external" href="http://docs.rackspace.com/networks/api/v2/cn-devguide/content/ch_preface.html">API Developer Guide</a></li>
<li><a class="reference external" href="http://docs.rackspace.com/networks/api/v2/cn-releasenotes/content/ch_preface.html">API release history</a></li>
</ul>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="networks.html" class="btn btn-neutral float-right" title="Networks"/>Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../monitoring/zones.html" class="btn btn-neutral" title="Zones"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2015, Jamie Hannaford, Shaunak Kashyap.
</p>
</div>
<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'1.12.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>