en-US/ip-vlan-tenant.xml

<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
-->
<section id="ip-vlan-tenant">
  <title>Reserving Public IP Addresses and VLANs for Accounts</title>
  <para>&PRODUCT; provides you the ability to reserve a set of public IP addresses and VLANs
    exclusively for an account. During zone creation, you can continue defining a set of VLANs and
    multiple public IP ranges. This feature extends the functionality to enable you to dedicate a
    fixed set of VLANs and guest IP addresses for a tenant.</para>
  <para>Note that if an account has consumed all the VLANs and IPs dedicated to it, the account can
    acquire two more resources from the system. &PRODUCT; provides the root admin with two
    configuration parameter to modify this default behavior&mdash;use.system.public.ips and
    use.system.guest.vlans. These global parameters enable the root admin to disallow an account
    from acquiring public IPs and guest VLANs from the system, if the account has dedicated
    resources and these dedicated resources have all been consumed. Both these configurations are
    configurable at the account level.</para>
  <para>This feature provides you the following capabilities:</para>
  <itemizedlist>
    <listitem>
      <para>Reserve a VLAN range and public IP address range from an Advanced zone and assign it to
        an account</para>
    </listitem>
    <listitem>
      <para>Disassociate a VLAN and public IP address range from an account</para>
    </listitem>
    <listitem>
      <para>View the number of public IP addresses allocated to an account</para>
    </listitem>
    <listitem>
      <para>Check whether the required range is available and is conforms to account limits.</para>
      <para>The maximum IPs per account limit cannot be superseded.</para>
    </listitem>
  </itemizedlist>
  <section id="howto-dedicate-ip">
    <title>Dedicating IP Address Ranges to an Account</title>
    <orderedlist>
      <listitem>
        <para>Log in to the &PRODUCT; UI as administrator.</para>
      </listitem>
      <listitem>
        <para>In the left navigation bar, click Infrastructure.</para>
      </listitem>
      <listitem>
        <para>In Zones, click View All.</para>
      </listitem>
      <listitem>
        <para>Choose the zone you want to work with.</para>
      </listitem>
      <listitem>
        <para>Click the Physical Network tab.</para>
      </listitem>
      <listitem>
        <para>In the Public node of the diagram, click Configure.</para>
      </listitem>
      <listitem>
        <para>Click the IP Ranges tab.</para>
        <para>You can either assign an existing IP range to an account, or create a new IP range and
          assign to an account.</para>
      </listitem>
      <listitem>
        <para>To assign an existing IP range to an account, perform the following:</para>
        <orderedlist numeration="loweralpha">
          <listitem>
            <para>Locate the IP range you want to work with.</para>
          </listitem>
          <listitem>
            <para>Click Add Account <inlinemediaobject>
                <imageobject>
                  <imagedata fileref="./images/addAccount-icon.png"/>
                </imageobject>
                <textobject>
                  <phrase>addAccount-icon.png: button to assign an IP range to an account.</phrase>
                </textobject>
              </inlinemediaobject>button.</para>
            <para>The Add Account dialog is displayed.</para>
          </listitem>
          <listitem>
            <para>Specify the following:</para>
            <itemizedlist>
              <listitem>
                <para><emphasis role="bold">Account</emphasis>: The account to which you want to
                  assign the IP address range.</para>
              </listitem>
              <listitem>
                <para><emphasis role="bold">Domain</emphasis>: The domain associated with the
                  account.</para>
              </listitem>
            </itemizedlist>
            <para>To create a new IP range and assign an account, perform the following:</para>
            <orderedlist numeration="loweralpha">
              <listitem>
                <para>Specify the following:</para>
                <itemizedlist>
                  <listitem>
                    <para><emphasis role="bold">Gateway</emphasis></para>
                  </listitem>
                  <listitem>
                    <para><emphasis role="bold">Netmask</emphasis></para>
                  </listitem>
                  <listitem>
                    <para><emphasis role="bold">VLAN</emphasis></para>
                  </listitem>
                  <listitem>
                    <para><emphasis role="bold">Start IP</emphasis></para>
                  </listitem>
                  <listitem>
                    <para><emphasis role="bold">End IP</emphasis></para>
                  </listitem>
                  <listitem>
                    <para><emphasis role="bold">Account</emphasis>: Perform the following:</para>
                    <orderedlist numeration="lowerroman">
                      <listitem>
                        <para>Click Account.</para>
                        <para>The Add Account page is displayed.</para>
                      </listitem>
                      <listitem>
                        <para>Specify the following:</para>
                        <itemizedlist>
                          <listitem>
                            <para><emphasis role="bold"><emphasis role="bold"
                                >Account</emphasis></emphasis>: The account to which you want to
                              assign an IP address range.</para>
                          </listitem>
                          <listitem>
                            <para><emphasis role="bold"><emphasis role="bold"
                                >Domain</emphasis></emphasis>: The domain associated with the
                              account.</para>
                          </listitem>
                        </itemizedlist>
                      </listitem>
                      <listitem>
                        <para>Click OK.</para>
                      </listitem>
                    </orderedlist>
                  </listitem>
                </itemizedlist>
              </listitem>
              <listitem>
                <para>Click Add.</para>
              </listitem>
            </orderedlist>
          </listitem>
        </orderedlist>
      </listitem>
    </orderedlist>
  </section>
  <section id="howto-dedicate-vlan">
    <title>Dedicating VLAN Ranges to an Account</title>
    <orderedlist>
      <listitem>
        <para>After the &PRODUCT; Management Server is installed, log in to the &PRODUCT; UI as
          administrator.</para>
      </listitem>
      <listitem>
        <para>In the left navigation bar, click Infrastructure.</para>
      </listitem>
      <listitem>
        <para>In Zones, click View All.</para>
      </listitem>
      <listitem>
        <para>Choose the zone you want to work with.</para>
      </listitem>
      <listitem>
        <para>Click the Physical Network tab.</para>
      </listitem>
      <listitem>
        <para>In the Guest node of the diagram, click Configure.</para>
      </listitem>
      <listitem>
        <para>Select the Dedicated VLAN Ranges tab.</para>
      </listitem>
      <listitem>
        <para>Click Dedicate VLAN Range.</para>
        <para>The Dedicate VLAN Range dialog is displayed.</para>
      </listitem>
      <listitem>
        <para>Specify the following:</para>
        <itemizedlist>
          <listitem>
            <para><emphasis role="bold"><emphasis role="bold">VLAN Range</emphasis></emphasis>: The
              VLAN range that you want to assign to an account.</para>
          </listitem>
          <listitem>
            <para><emphasis role="bold"><emphasis role="bold">Account</emphasis></emphasis>: The
              account to which you want to assign the selected VLAN range.</para>
          </listitem>
          <listitem>
            <para><emphasis role="bold"><emphasis role="bold">Domain</emphasis></emphasis>: The
              domain associated with the account.</para>
          </listitem>
        </itemizedlist>
      </listitem>
    </orderedlist>
  </section>
</section>