.. _Managing Traffic Types and Networks:

Managing Traffic Types and Networks
-----------------------------------

.. _vinfra cluster traffic-type create:

vinfra cluster traffic-type create
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Create a new traffic type:

:: 

   usage: vinfra cluster traffic-type create --port <port> <traffic-type-name>

``--port <port>``
   Traffic type port

``<traffic-type-name>``
   Traffic type name

Example:

::

   # vinfra cluster traffic-type create "MyTrafficType" --port 6900
   +-----------+-----------------+
   | Field     | Value           |
   +-----------+-----------------+
   | exclusive | False           |
   | name      | MyTrafficType   |
   | port      | 6900            |
   | type      | custom          |
   +-----------+-----------------+

This command creates a custom traffic type ``MyTrafficType`` on port 6900.

.. _vinfra cluster traffic-type list:

vinfra cluster traffic-type list
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

List available traffic types:

:: 

   usage: vinfra cluster traffic-type list

Example:

::

   # vinfra cluster traffic-type list
   +---------------------+------------+-----------+------+
   | name                | type       | exclusive | port |
   +---------------------+------------+-----------+------+
   | Storage             | predefined | True      |      |
   | Internal management | predefined | True      |      |
   | OSTOR private       | predefined | True      |      |
   | S3 public           | predefined | False     |      |
   | iSCSI               | predefined | False     |      |
   | NFS                 | predefined | False     |      |
   | ABGW private        | predefined | True      |      |
   | ABGW public         | predefined | False     |      |
   | Admin panel         | predefined | False     |      |
   | SSH                 | predefined | False     |      |
   | VM public           | predefined | False     |      |
   | VM private          | predefined | True      |      |
   | Compute API         | predefined | True      |      |
   | MyTrafficType       | custom     | False     | 6900 |
   +---------------------+------------+-----------+------+

This command lists all traffic types in |product_name|.

.. _vinfra cluster traffic-type show:

vinfra cluster traffic-type show
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Show details of a traffic type:

:: 

   usage: vinfra cluster traffic-type show <traffic-type>

``<traffic-type>``
   Traffic type name

Example:

::

   # vinfra cluster traffic-type show Storage
   +-----------+------------+
   | Field     | Value      |
   +-----------+------------+
   | exclusive | True       |
   | name      | Storage    |
   | port      |            |
   | type      | predefined |
   +-----------+------------+

This command shows the details of the traffic type ``Storage``.

.. _vinfra cluster traffic-type set:

vinfra cluster traffic-type set
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Modify traffic type parameters:

:: 

   usage: vinfra cluster traffic-type set [--name <name>] [--port <port>] <traffic-type>

``--name <name>``
   A new name for the traffic type

``--port <port>``
   A new port for the traffic type

``<traffic-type>``
   Traffic type name

Example:

::

   # vinfra cluster traffic-type set "MyTrafficType" \
   --name "MyOtherTrafficType" --port 6901
   +-----------+--------------------+
   | Field     | Value              |
   +-----------+--------------------+
   | exclusive | False              |
   | name      | MyOtherTrafficType |
   | port      | 6901               |
   | type      | custom             |
   +-----------+--------------------+

This command renames the traffic type ``MyTrafficType`` to ``MyOtherTrafficType`` and changes its port to 6901.

.. _vinfra cluster traffic-type delete:

vinfra cluster traffic-type delete
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Delete a traffic type:

:: 

   usage: vinfra cluster traffic-type delete <traffic-type>

``<traffic-type>``
   Traffic type name

Example:

::

   # vinfra cluster traffic-type delete "MyOtherTrafficType"
   Operation successful

This command deletes the custom traffic type ``MyOtherTrafficType``.

.. _vinfra cluster network create:

vinfra cluster network create
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Create a new network:

:: 

   usage: vinfra cluster network create [--traffic-types <traffic-types>] <network-name>

``--traffic-types <traffic-types>``
   A comma-separated list of traffic type IDs or names

``<network-name>``
   Network name

Example:

::

   # vinfra cluster network create MyNet --traffic-types ssh
   +-------+--------------------------------------+
   | Field | Value                                |
   +-------+--------------------------------------+
   | id    | 03d5eeb3-1833-4626-885d-dd066635f5de |
   | name  | MyNet                                |
   | roles | - SSH                                |
   | type  | Custom                               |
   +-------+--------------------------------------+

This command creates a custom network ``MyNet`` and assigns the traffic type ``SSH`` to it.

.. _vinfra cluster network list:

vinfra cluster network list
~~~~~~~~~~~~~~~~~~~~~~~~~~~

List available networks:

:: 

   usage: vinfra cluster network list

Example:

::

   # vinfra cluster network list
   +--------------------------------------+---------+-----------------------+
   | id                                   | name    | roles                 |
   +--------------------------------------+---------+-----------------------+
   | 358bdc39-cd8b-4565-8ebf-e7c12dcd1cf7 | Public  | - ABGW public         |
   |                                      |         | - iSCSI               |
   |                                      |         | - NFS                 |
   |                                      |         | - S3 public           |
   |                                      |         | - SSH                 |
   |                                      |         | - Admin Panel         |
   | 6095a997-e5f1-493d-a750-41ddf277153b | Private | - ABGW private        |
   |                                      |         | - Internal Management |
   |                                      |         | - OSTOR private       |
   |                                      |         | - SSH                 |
   |                                      |         | - Storage             |
   +--------------------------------------+---------+-----------------------+

This command lists all networks in |product_name|.

.. _vinfra cluster network show:

vinfra cluster network show
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Show details of a network:

:: 

   usage: vinfra cluster network show <network>

``<network>``
   Network ID or name

Example:

::

   # vinfra cluster network show MyNet
   +-------+--------------------------------------+
   | Field | Value                                |
   +-------+--------------------------------------+
   | id    | 03d5eeb3-1833-4626-885d-dd066635f5de |
   | name  | MyNet                                |
   | roles | - SSH                                |
   | type  | Custom                               |
   +-------+--------------------------------------+

This command shows the details of the custom network ``MyNet``.

.. _vinfra cluster network set:

vinfra cluster network set
~~~~~~~~~~~~~~~~~~~~~~~~~~

Modify network parameters:

:: 

   usage: vinfra cluster network set [--name <network-name>] 
                                     [--traffic-types <traffic-types> |
                                     --add-traffic-types <traffic-types> | 
                                     --del-traffic-types <traffic-types>] 
                                     <network>

``--name <network-name>``
   Network name

``--traffic-types <traffic-types>``
   A comma-separated list of traffic type names (overwrites network's current traffic types)

``--add-traffic-types <traffic-types>``
   A comma-separated list of traffic type names (adds the specified traffic types to the network)

``--del-traffic-types <traffic-types>``
   A comma-separated list of traffic type names (removes the specified traffic types from the network)

``<network>``
   Network ID or name

Example:

::

   # vinfra cluster network set MyNet --name MyOtherNet --add-traffic-types iscsi,nfs
   +---------+--------------------------------------+
   | Field   | Value                                |
   +---------+--------------------------------------+
   | task_id | b29f6f66-37d7-47de-b02e-9f4087ad932b |
   +---------+--------------------------------------+

This command creates a task to rename the network ``MyNet`` to ``MyOtherNet`` and assign to it the traffic types ``iSCSI`` and ``NFS``.

Task outcome:

::

   # vinfra task show b29f6f66-37d7-47de-b02e-9f4087ad932b
   +---------+-------------------------------------------------------------+
   | Field   | Value                                                       |
   +---------+-------------------------------------------------------------+
   | args    | - 03d5eeb3-1833-4626-885d-dd066635f5de                      |
   | kwargs  | name: MyOtherNet                                            |
   |         | roles:                                                      |
   |         | - ssh                                                       |
   |         | - iscsi                                                     |
   |         | - nfs                                                       |
   | name    | backend.presentation.network.roles.tasks.RolesSetChangeTask |
   | result  | id: 03d5eeb3-1833-4626-885d-dd066635f5de                    |
   |         | name: MyOtherNet                                            |
   |         | roles:                                                      |
   |         | - iSCSI                                                     |
   |         | - NFS                                                       |
   |         | - SSH                                                       |
   |         | type: Custom                                                |
   | state   | success                                                     |
   | task_id | b29f6f66-37d7-47de-b02e-9f4087ad932b                        |
   +---------+-------------------------------------------------------------+

.. _vinfra cluster network set-bulk:

vinfra cluster network set-bulk
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Modify traffic types of multiple networks:

:: 

   usage: vinfra cluster network set-bulk --network <network>:<traffic-types>

``--network <network>:<traffic-types>``
   Network configuration in the format:

   - ``<network>``: network ID or name;
   - ``<traffic-types>``: a comma-separated list of traffic type names; 

   (this option can be used multiple times).

Example:

::

   # vinfra cluster network set-bulk --network MyNet1:snmp --network MyNet2:ssh,snmp
   +---------+--------------------------------------+
   | Field   | Value                                |
   +---------+--------------------------------------+
   | task_id | c774f55d-c45b-42cd-ac9e-16fc196e9283 |
   +---------+--------------------------------------+

This command creates a task to change the traffic type set of the network ``MyNet1`` to ``SNMP`` and that of ``MyNet2`` to ``SSH`` and ``SNMP``.

Task outcome:

::

   # vinfra task show c774f55d-c45b-42cd-ac9e-16fc196e9283
   +---------+-----------------------------------------------------------------+
   | Field   | Value                                                           |
   +---------+-----------------------------------------------------------------+
   | details |                                                                 |
   | name    | backend.presentation.network.roles.tasks.RolesSetBulkChangeTask |
   | result  | - id: adf49487-9deb-4180-bb0c-08a906257981                      |
   |         |   name: MyNet1                                                  |
   |         |   roles:                                                        |
   |         |   - SNMP                                                        |
   |         |   type: Custom                                                  |
   |         | - id: 3f6ff4a3-31bc-440b-a36f-d755c80d5932                      |
   |         |   name: MyNet2                                                  |
   |         |   roles:                                                        |
   |         |   - SNMP                                                        |
   |         |   - SSH                                                         |
   |         |   type: Custom                                                  |
   | state   | success                                                         |
   | task_id | c774f55d-c45b-42cd-ac9e-16fc196e9283                            |
   +---------+-----------------------------------------------------------------+

.. _vinfra cluster network delete:

vinfra cluster network delete
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Delete a network:

:: 

   usage: vinfra cluster network delete <network>

``<network>``
   Network ID or name

Example:

::

   # vinfra cluster network delete MyOtherNet
   Operation successful

This command deletes the network ``MyOtherNet``.