Интерфейс командной строки DeckCrew CLI

Для использования DeckCrew CLI необходимо зайти на узел развёртывания.

Выполните команду для получения справки по использованию DeckCrew CLI: dctl --help.

Глобальные настройки

global set

Описание

Установить глобальные настройки для развёртывания

Использование

$ dctl global set --help
usage: dctl global set [-h] [--interactive true|false]

options:
  -h, --help            show this help message and exit
  --interactive true|false
                        Define behaviour on failure

Параметры

Имя	Обязательный	Описание
interactive	Нет	Настроить интерактивный режим работы cotea. По умолчанию: true

Результат

Пустая строка, если команда выполнена успешно.

Физические узлы

См. также

1. Настройка узлов

node list

Описание

Посмотреть список baremetal узлов в системе

Использование

$ dctl node list --help
 usage: dctl node list [-h] [-f {json,yaml,table}]

 options:
   -h, --help            show this help message and exit
   -f {json,yaml,table}, --format {json,yaml,table}
                         Output format

node create

Описание

Завести данные о baremetal узле в системе при помощи BMC или SSH

Использование

$ dctl node create --help
 usage: dctl node create [-h] [--no-bmc] [--bmc-type {ipmi,idrac,ilo}] [--user USER] --address ADDRESS
                         [--password PASSWORD] [--pxe-mac PXE_MAC]
                         name

 positional arguments:
   name                  Node name

 options:
   -h, --help            show this help message and exit
   --no-bmc              If set then BMC will not be used. And node will be assumed to have installed OS
                         and IP-address for connection.
   --bmc-type {ipmi,idrac,ilo}
                         BMC type
   --user USER           BMC or SSH login username
   --address ADDRESS     BMC or SSH IPv4 address
   --password PASSWORD   BMC or SSH login password
   --pxe-mac PXE_MAC     MAC address of the PXE interface (only for BMC node)

Параметры

Имя	Обязательный	Описание
name	Да	Имя узла в системе
no-bmc	Нет	Не использовать BMC для узла. По умолчанию: false
bmc-type	Нет	Тип BMC. По умолчанию: ipmi (Только для BMC) Один из: ipmi, idrac, ilo
user	Нет	Имя пользователя BMC или SSH
address	Да	IPv4 адрес BMC или SSH
password	Нет	Пароль BMC или SSH
pxe-mac	Нет	MAC адрес PXE интерфейса (Только для BMC)

Результат

Пустая строка, если команда выполнена успешно.

node show

Описание

Посмотреть данные о baremetal узле в системе

Использование

$ dctl node show --help
 usage: dctl node show [-h] [-f {json,yaml,table}] name

 positional arguments:
   name                  Node name

 options:
   -h, --help            show this help message and exit
   -f {json,yaml,table}, --format {json,yaml,table}
                         Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя узла в системе

node delete

Описание

Удалить baremetal узел из системы

Использование

$ dctl node delete --help
 usage: dctl node delete [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя узла в системе

Результат

Пустая строка, если команда выполнена успешно.

node introspect

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node introspect --help
 usage: dctl node introspect [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя узла в системе

Результат

Пустая строка, если команда выполнена успешно.

node maintain

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node maintain --help
 usage: dctl node maintain [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Результат

Пустая строка, если команда выполнена успешно.

node unmaintain

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node unmaintain --help
 usage: dctl node unmaintain [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Результат

Пустая строка, если команда выполнена успешно.

node power-off

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node power-off --help
 usage: dctl node power-off [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Результат

Пустая строка, если команда выполнена успешно.

node power-on

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node power-on --help
 usage: dctl node power-on [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Результат

Пустая строка, если команда выполнена успешно.

node reboot

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node reboot --help
 usage: dctl node reboot [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Результат

Пустая строка, если команда выполнена успешно.

node manage

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node manage --help
 usage: dctl node manage [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Результат

Пустая строка, если команда выполнена успешно.

node provide

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node provide --help
 usage: dctl node provide [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Результат

Пустая строка, если команда выполнена успешно.

node configure

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node configure --help
 usage: dctl node configure [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Результат

Пустая строка, если команда выполнена успешно.

node undeploy

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node undeploy --help
 usage: dctl node undeploy [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Результат

Пустая строка, если команда выполнена успешно.

node clean

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node clean --help
 usage: dctl node clean [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Результат

Пустая строка, если команда выполнена успешно.

node drives-configure

Описание

Выполнить команду на baremetal узле в системе

Использование

$ dctl node drives-configure --help
 usage: dctl node drives-configure [-h] name

 positional arguments:
   name        Node name

 options:
   -h, --help  show this help message and exit

Результат

Пустая строка, если команда выполнена успешно.

Лицензирование

См. также

1. Лицензирование

2. Лицензирование узлов

license resource list

Описание

Вывести список ресурсов лицензии.

Использование

$ dctl license resource list --help
usage: dctl license resource list [-h] [-f {json,yaml,table}] [--node NODE] [--available]

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format
  --node NODE           Get sealed resources for a specific node by name
  --available           Get unsealed resources matched to a specific node. Use with --node

Пример

$ dctl license resource list
+---------------+--------------------------------------+-------+------------------------------------+---------------------------+----------------------------------------------------------------------------------+--------+-----------+
| resource_type | resource_uuid                        | count | attributes                         | added_at                  | node_uuids                                                                       | sealed | available |
+---------------+--------------------------------------+-------+------------------------------------+---------------------------+----------------------------------------------------------------------------------+--------+-----------+
| ceph_nodes    | 7da15700-5c3b-4406-9a34-87ef3b86bf03 | 3     | {"storage_name": "storage"}        | 2026-06-02T12:14:43+00:00 | []                                                                               | 0      | 3         |
| compute_nodes | 1d48abe2-1253-437b-ad5d-dbf0825155eb | 2     | {"cpu_cores": -1, "gpu_count": -1} | 2026-06-02T12:14:43+00:00 | ["1358d7bd-1a2f-4c3b-94e1-7b7231197662", "f8b54df1-ea3b-4723-adff-7839ead01ba5"] | 2      | 0         |
| control_nodes | d57689ff-32ca-4f10-9b49-999d1b55bf6b | 3     | {}                                 | 2026-06-02T12:14:43+00:00 | ["4bf22cba-5811-423c-b83d-8501d928d8e9"]                                         | 1      | 2         |
+---------------+--------------------------------------+-------+------------------------------------+---------------------------+----------------------------------------------------------------------------------+--------+-----------+

Параметры

Имя	Обязательный	Описание
node	Нет	Имя сервера, для которого необходимо вывести список ресурсов лицензии
available	Нет	Вывести список ресурсов лицензии, которые могут быть зафиксированы на сервере. Используется вместе с параметром node.

Результат

Имя	Описание
resource_type	Тип ресурса лицензии.
resource_uuid	UUID ресурса лицензии.
count	Количество ресурсов лицензии данного типа.
attributes	Атрибуты ресурса лицензии в формате JSON.
added_at	Дата и время добавления ресурса лицензии.
node_uuids	Список UUID серверов, на которых зафиксирован ресурс лицензии.
sealed	Количество ресурсов лицензии данного типа, зафиксированных на серверах.
available	Количество ресурсов лицензии данного типа, которые могут быть зафиксированы на серверах.

license resource seal

Описание

Зафиксировать ресурс лицензии на конкретный сервер.

Использование

$ dctl license resource seal --help
usage: dctl license resource seal [-h] resource node

positional arguments:
  resource    Resource uuid
  node        Node name

options:
  -h, --help  show this help message and exit

Пример

$ dctl license resource seal 123456-7890-1234-5678-1234567890ab node1

Параметры

Имя	Обязательный	Описание
resource	Да	UUID ресурса лицензии, который необходимо зафиксировать на сервере.
node	Да	Имя сервера, на котором необходимо зафиксировать ресурс лицензии.

Результат

Пустая строка, если команда выполнена успешно.

license service list

Описание

Вывести список включённых сервисов лицензии.

Использование

$ dctl license service list --help
usage: dctl license service list [-h] [-f {json,yaml,table}]

options:
    -h, --help            show this help message and exit
    -f {json,yaml,table}, --format {json,yaml,table}
                            Output format

Пример

$ dctl license service list
+-----------------+
| AosCloudManager |
| AosMonitor      |
| AosRsServer     |
| BGP             |
| DBMS            |
| DNSaaS          |
| Kubernetes      |
| SFC             |
| Surguch         |
| TRAM            |
| VPNaaS          |
+-----------------+

Результат

Список включённых сервисов лицензии.

Сети

См. также

1. Настройка сетей

network list

Описание

Посмотреть данные о сетях в системе

Использование

$ dctl network list --help
 usage: dctl network list [-h] [-f {json,yaml,table}]

 options:
   -h, --help            show this help message and exit
   -f {json,yaml,table}, --format {json,yaml,table}
                         Output format

network import

Описание

Использовать кастомный файл с данными о сетях

Использование

$ dctl network import --help
 usage: dctl network import [-h] [-f {json,yaml,table}] --file FILE

 options:
   -h, --help            show this help message and exit
   -f {json,yaml,table}, --format {json,yaml,table}
                         Output format
   --file FILE           Path to the new network data file

Параметры

Имя	Обязательный	Описание
file	Да	Путь к файлу с новыми данными о сетях.

network add

Описание

Добавить новую сеть

Использование

$ dctl network add --help
 usage: dctl network add [-h] [--mtu MTU] [--vip] [--service-net-map-replace NETWORK_NAME] --ip-subnet
                         CIDR [--vlan VLAN] [--gateway-ip IPv4] [--routes JSON or 'k1=v1,k2=v2...']
                         [--allocation-pools JSON or 'k1=v1,k2=v2...']
                         name

 positional arguments:
   name                  Network name

 options:
   -h, --help            show this help message and exit
   --mtu MTU             MTU for the network
   --vip                 Add VIP tag for the network
   --service-net-map-replace NETWORK_NAME
                         Set this network to replace default networks for service net mapping
   --ip-subnet CIDR      Subnet CIDR for the network
   --vlan VLAN           VLAN for the network
   --gateway-ip IPv4     Gateway for the network
   --routes JSON or 'k1=v1,k2=v2...'
                         Routes for the network
   --allocation-pools JSON or 'k1=v1,k2=v2...'
                         Allocation pools for the network

Параметры

Имя	Обязательный	Описание
name	Да	Имя новой сети
mtu	Нет	MTU для сети. По умолчанию: 1500
vip	Нет	Добавить тег VIP для сети.
service-net-map-replace	Нет	Использовать сеть в качестве замены для сетей по умолчанию для сопоставления сервисов.
ip-subnet	Да	CIDR сети
vlan	Нет	Номер VLAN
gateway-ip	Нет	Адрес шлюза
routes	Нет	Дополнительные маршруты
allocation-pools	Нет	Пул используемых адресов. Используйте формат JSON

Результат

Пустая строка, если команда выполнена успешно.

network delete

Описание

Удалить сеть из системы

Использование

$ dctl network delete --help
 usage: dctl network delete [-h] name

 positional arguments:
   name        Network name

 options:
   -h, --help  show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя сети

Результат

Пустая строка, если команда выполнена успешно.

Сетевые планы

Сетевые планы позволяют управлять топологией сети и виртуальными интерфейсами на узлах.

В системе есть заранее подготовленные сетевые планы, которые можно использовать для развёртывания.

Пользователь может создавать свои сетевые планы, которые будут использоваться при развёртывании.

Сетевые планы представлены в формате os-net-config, который является инструментом для настройки сетевых интерфейсов от OpenStack.

См. также

1. Сетевые планы

netplan list

Описание

Посмотреть список сетевых планов

Использование

$ dctl netplan list --help
  usage: dctl netplan list [-h] [-f {json,yaml,table}] [--public] [--default] [--instance INSTANCE]

  options:
    -h, --help            show this help message and exit
    -f {json,yaml,table}, --format {json,yaml,table}
                          Output format
    --public              List public network plans
    --default             List default network plans from tripleo_network_config Ansible role
    --instance INSTANCE   List instance network plans

Без аргументов отображаются только публичные сетевые планы, созданные пользователем. Можно использовать несколько аргументов одновременно.

Параметры

Имя	Обязательный	Описание
public	Нет	Показать список публичных планов, созданных пользователем
default	Нет	Показать список сетевых планов из Ansible роли tripleo_network_config
instance	Нет	Показать список приватных планов, созданных пользователем

netplan create

Описание

Создать новый сетевой план

Использование

$ dctl netplan create --help
  usage: dctl netplan create [-h] [-f {json,yaml,table}] [--instance INSTANCE] name

  positional arguments:
    name                  Network plan name

  options:
    -h, --help            show this help message and exit
    -f {json,yaml,table}, --format {json,yaml,table}
                          Output format
    --instance INSTANCE   List instance network plans

По умолчанию создаётся публичный сетевой план. Если указан параметр --instance, то создаётся приватный сетевой план для развёртывания.

Параметры

Имя	Обязательный	Описание
name	Да	Имя нового сетевого плана
instance	Нет	Имя развёртывания для создания приватного плана

netplan delete

Описание

Удалить сетевой план

Использование

$ dctl netplan delete --help
  usage: dctl netplan delete [-h] name

  positional arguments:
    name        Network plan name

  options:
    -h, --help  show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя сетевого плана

Результат

Пустая строка, если команда выполнена успешно.

netplan vif list

Описание

Посмотреть список виртуальных интерфейсов сетевого плана

Использование

$ dctl netplan vif list --help
  usage: dctl netplan vif list [-h] [-f {json,yaml,table}] name

  positional arguments:
    name                  Netplan vif name

  options:
    -h, --help            show this help message and exit
    -f {json,yaml,table}, --format {json,yaml,table}
                          Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя сетевого плана

netplan vif add

Описание

Добавить виртуальный интерфейс в сетевой план

Использование

$ dctl netplan vif add --help
  usage: dctl netplan vif add [-h] --type TYPE [--network NETWORK] [--with-routes]
                              [--member-of MEMBER_OF] [--property PROPERTY]
                              name vif_name

  positional arguments:
    name                  Netplan vif name
    vif_name              Name of the VIF

  options:
    -h, --help            show this help message and exit
    --type TYPE           Type of the VIF
    --network NETWORK     Network to which the VIF belongs
    --with-routes         Configure routes for the VIF
    --member-of MEMBER_OF
                          Group to which the VIF belongs
    --property PROPERTY   Set a property for the VIF

Параметры

Имя	Обязательный	Описание
name	Да	Имя сетевого плана
vif_name	Да	Имя виртуального интерфейса. Соответствует названию интерфейса в системе
type	Да	Тип виртуального интерфейса. Например: interface, vlan, ovs_bridge, …
network	Нет	Имя сети для адресации виртуального интерфейса из списка заведённых сетей в системе. Например: external, internal_api, …
with-routes	Нет	Добавить маршруты при изменении адресации виртуального интерфейса. Например, адрес шлюза.
member-of	Нет	Добавить виртуальный интерфейс к другому интерфейсу. Например, interface можно добавить в ovs_bond
property	Нет	Дополнительные свойства виртуального интерфейса.

Результат

Пустая строка, если команда выполнена успешно.

netplan vif remove

Описание

Удалить виртуальный интерфейс из сетевого плана

Использование

$ dctl netplan vif remove --help
  usage: dctl netplan vif remove [-h] name vif_name

  positional arguments:
    name        Netplan vif name
    vif_name    Name of the VIF

  options:
    -h, --help  show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя сетевого плана
vif_name	Да	Имя виртуального интерфейса

Результат

Пустая строка, если команда выполнена успешно.

netplan vif show

Описание

Посмотреть данные виртуального интерфейса сетевого плана

Использование

$ dctl netplan vif show --help
  usage: dctl netplan vif show [-h] [-f {json,yaml,table}] name vif_name

  positional arguments:
    name                  Netplan vif name
    vif_name              Name of the VIF

  options:
    -h, --help            show this help message and exit
    -f {json,yaml,table}, --format {json,yaml,table}
                          Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя сетевого плана
vif_name	Да	Имя виртуального интерфейса

netplan vif set

Описание

Установить параметры виртуального интерфейса сетевого плана

Использование

$ dctl netplan vif set --help
  usage: dctl netplan vif set [-h] [--network NETWORK] [--with-routes] [--member-of MEMBER_OF]
                              [--property PROPERTY]
                              name vif_name

  positional arguments:
    name                  Netplan vif name
    vif_name              Name of the VIF

  options:
    -h, --help            show this help message and exit
    --network NETWORK     Network to which the VIF belongs
    --with-routes         Configure routes for the VIF
    --member-of MEMBER_OF
                          Group to which the VIF belongs
    --property PROPERTY   Set a property for the VIF

Параметры

Имя	Обязательный	Описание
name	Да	Имя сетевого плана
vif_name	Да	Имя виртуального интерфейса
network	Нет	Имя сети для адресации виртуального интерфейса из списка заведённых сетей в системе. Например: external, internal_api, …
with-routes	Нет	Добавить маршруты при изменении адресации виртуального интерфейса. Например, адрес шлюза.
member-of	Нет	Добавить виртуальный интерфейс к другому интерфейсу. Например, interface можно добавить в ovs_bond
property	Нет	Дополнительные свойства виртуального интерфейса.

Результат

Пустая строка, если команда выполнена успешно.

netplan vif unset

Описание

Удалить параметры виртуального интерфейса сетевого плана

Использование

$ dctl netplan vif unset --help
  usage: dctl netplan vif unset [-h] [--network] [--member-of] [--property name] name vif_name

  positional arguments:
    name             Netplan vif name
    vif_name         Name of the VIF

  options:
    -h, --help       show this help message and exit
    --network        Network to which the VIF belongs
    --member-of      Group to which the VIF belongs
    --property name  Show a property for the VIF

Параметры

Имя	Обязательный	Описание
name	Да	Имя сетевого плана
vif_name	Да	Имя виртуального интерфейса
network	Нет	Удалить назначенную адресацию из сети.
member-of	Нет	Удалить привязку интерфейса к другому интерфейсу
property	Нет	Удалить свойство виртуального интерфейса

Результат

Пустая строка, если команда выполнена успешно.

Образы развёртывания

image list

Описание

Посмотреть список образов для Ironic узлов

Использование

$ dctl image list --help
 usage: dctl image list [-h] [-f {json,yaml,table}]

 options:
   -h, --help            show this help message and exit
   -f {json,yaml,table}, --format {json,yaml,table}
                         Output format

Хранилища

Управление хранилищами для развёртываний типа OpenStack.

См. также

1. Настройка хранилищ

storage list

Описание

Посмотреть список хранилищ в системе

Использование

$ dctl storage list --help
usage: dctl storage list [-h] [-f {json,yaml,table}]

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

storage create

Описание

Создать новое хранилище

Использование

$ dctl storage create --help
usage: dctl storage create [-h] --type {ceph,iscsi,nfs,sanlock,tatlin} [--property PROPERTY] name

positional arguments:
  name                  Storage name

options:
  -h, --help            show this help message and exit
  --type {ceph,iscsi,nfs,sanlock,tatlin}
                        Storage type
  --property PROPERTY   Storage properties

Параметры

Имя	Обязательный	Описание
name	Да	Имя хранилища
type	Да	Тип хранилища. Один из: ceph, iscsi, nfs, sanlock, tatlin
property	Нет	Дополнительные свойства хранилища.

Результат

Пустая строка, если команда выполнена успешно.

storage show

Описание

Посмотреть данные о хранилище

Использование

$ dctl storage show --help
usage: dctl storage show [-h] [-f {json,yaml,table}] name

positional arguments:
  name                  Storage name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя хранилища

storage delete

Описание

Удалить хранилище из системы

Использование

$ dctl storage delete --help
usage: dctl storage delete [-h] name

positional arguments:
  name        Storage name

options:
  -h, --help  show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя хранилища

Результат

Пустая строка, если команда выполнена успешно.

Инстансы развёртывания

instance list

Описание

Посмотреть список всех развёртываний

Использование

$ dctl instance list --help
usage: dctl instance list [-h] [-f {json,yaml,table}]

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

instance create

Описание

Создать шаблоны развёртывания

Использование

$ dctl instance create --help
usage: dctl instance create [-h] [-f {json,yaml,table}] [--type {openstack,ceph,adminpoint,demo}] name

positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format
  --type {openstack,ceph,adminpoint,demo}
                        Instance type

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
type	Нет	Тип развёртывания. По умолчанию: openstack. Один из: openstack, ceph, demo, adminpoint

instance show

Описание

Посмотреть данные о развёртывании

Использование

$ dctl instance create --help
usage: dctl instance create [-h] [-f {json,yaml,table}] [--type {openstack,ceph,adminpoint,demo}] name

positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format
  --type {openstack,ceph,adminpoint,demo}
                        Instance type
[stack@eng-101-astd-32-undercloud ~]$ dctl instance show --help
usage: dctl instance show [-h] [-f {json,yaml,table}] name

positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания

instance delete

Описание

Удалить развёртывание

Использование

$ dctl instance delete --help
usage: dctl instance delete [-h] [--templates] [--deployment] name

positional arguments:
  name          Instance name

options:
  -h, --help    show this help message and exit
  --templates   Delete instance templates
  --deployment  Delete instance deployment

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
templates	Нет	Удалить шаблоны развёртывания
deployment	Нет	Удалить все ресурсы связанные с развёртыванием. Это действие выключит все узлы, использованные при развёртывании.

Результат

Пустая строка, если команда выполнена успешно.

instance deploy

Описание

Запустить один из этапов развёртывания в screen

Использование

$ dctl instance deploy --help
usage: dctl instance deploy [-h] name {networks,vips,servers,validate,services,stop,skip,retry}

positional arguments:
  name                  Instance name
  {networks,vips,servers,validate,services,stop,skip,retry}
                        Action to perform

options:
  -h, --help            show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
action	Да	Этап развёртывания. Один из: networks, vips, servers, validate, services, stop, skip, retry.

Результат

Логи выполнения операции

instance apply

Описание

Запустить все этапы развёртывания в интерактивном режиме

Использование

$ dctl instance apply --help
usage: dctl instance apply [-h] name

positional arguments:
  name        Instance name

options:
  -h, --help  show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания

Результат

Логи выполнения операции

instance update

Описание

Пересоздать контейнер на узлах с обновлением образа контейнера

Использование

$ dctl instance update --help
usage: dctl instance update [-h] [--host HOST | --role ROLE] [--container CONTAINER]
                            [--command COMMAND] [--templates] [--finish] [--packages] [--repo REPO]
                            [--no-use-deploy-images]
                            [--pcs-service {haproxy,galera,rabbitmq,cinder,redis,frr-manager}]
                            name

positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  --host HOST           Node name to operate on.
  --role ROLE           Role for nodes to operate on.
  --container CONTAINER
                        Container name.
  --command COMMAND     Update container running command. Only for --container
  --templates           Update instance templates.
  --finish              Finish updating templates. Only for --templates
  --packages            Update instance packages.
  --repo REPO           Specify updates repo. Only for --packages
  --no-use-deploy-images
                        Disable using deploy images for searching packages. This may be unreliable as
                        packages are only updated without installing new ones. Only for --packages
  --pcs-service {haproxy,galera,rabbitmq,cinder,redis,frr-manager}
                        Pacemaker service name to update container for.

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
host	Нет	Имя узла
role	Нет	Имя роли
container	Нет	Имя контейнера
command	Нет	Изменить команду старта при пересоздании контейнера
templates	Нет	Флаг для обновления шаблонов
finish	Нет	Флаг для завершения обновления шаблонов (только в случае ошибки обновления)
packages	Нет	Флаг для обновления пакетов
repo	Нет	Репозиторий для обновления пакетов
no-use-deploy-images	Нет	Не использовать образы для развёртывания при поиске пакетов
pcs-service	Нет	Имя сервиса Pacemaker для обновления контейнера Один из: haproxy, galera, rabbitmq, cinder, redis

Результат

Логи выполнения операции

instance node list

Описание

Посмотреть список назначенных для развёртывания узлов

Использование

$ dctl instance node list --help
usage: dctl instance node list [-h] [-f {json,yaml,table}] name

positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания

instance node add

Описание

Добавить узел в развёртывание

Использование

$ dctl instance node add --help
usage: dctl instance node add [-h] --role ROLE [--hostname HOSTNAME] [--image IMAGE]
                              [--network-plan NETWORK_PLAN]
                              [--default-route-network DEFAULT_ROUTE_NETWORK] [--fixed-ip FIXED_IP]
                              name node_name

positional arguments:
  name                  Instance name
  node_name             Name (if managed) or hostname (if unmanaged) of the node assigned to the
                        instance

options:
  -h, --help            show this help message and exit
  --role ROLE           Role of the node
  --hostname HOSTNAME   Hostname of the node
  --image IMAGE         Image's path to use for the node. Default is set by Role.
  --network-plan NETWORK_PLAN
                        Network plan to use for the node. Default is set by Role.
  --default-route-network DEFAULT_ROUTE_NETWORK
                        Default route network to use for the node, default is set by Role.
  --fixed-ip FIXED_IP   Fixed IP address to use for the node. Required for ctlplane if node is not
                        managed by Ironic. By default IP addresses are assigned by Neutron.

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
node_name	Да	Имя baremetal узла (в режиме managed) или желаемый хостней (в режиме unmanaged)
role	Да	Роль узла, соответствующая списку устанавливаемых сервисов
hostname	Нет	Хостнейм узла. По умолчанию: значение назначается системой исходя из имени роли и развёртывания
image	Нет	Путь до образа. Используется в режиме managed. Значение по умолчанию определяется ролью.
network-plan	Нет	Сетевой план для настройки сетей на узле. Значение по умолчанию определяется ролью.
default-route-network	Нет	Сеть для назначения шлюза при настройке сетей. Значение по умолчанию определяется ролью.
fixed-ip	Нет	Желаемый IP адрес в определённой сети назначенной узлу. Требуется в режиме unmanaged для сети ctlplane. По умолчанию адреса назначаются сервисом Neutron на узле развёртывания.

Результат

Пустая строка, если команда выполнена успешно.

instance node remove

Описание

Отцепить узел от развёртывания

Использование

$ dctl instance node remove --help
usage: dctl instance node remove [-h] name node_name

positional arguments:
  name        Instance name
  node_name   Name (if managed) or hostname (if unmanaged) of the node assigned to the instance

options:
  -h, --help  show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
node_name	Да	Имя узла

Результат

Пустая строка, если команда выполнена успешно.

instance role show

Описание

Посмотреть настройки по умолчанию для узлов роли

Использование

$ dctl instance role show  --help
usage: dctl instance role show [-h] [-f {json,yaml,table}] name role_name

positional arguments:
  name                  Instance name
  role_name             Role name assigned to the nodes of the instance

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
role_name	Да	Имя роли

instance role set

Описание

Назначить настройки по умолчанию для узлов роли

Использование

$ dctl instance role set --help
usage: dctl instance role set [-h] [--image IMAGE] [--network-plan NETWORK_PLAN]
                              [--default-route-network DEFAULT_ROUTE_NETWORK] [--network NETWORK]
                              name role_name

positional arguments:
  name                  Instance name
  role_name             Role name assigned to the nodes of the instance

options:
  -h, --help            show this help message and exit
  --image IMAGE         Default image's path to use for the nodes.
  --network-plan NETWORK_PLAN
                        Default network plan to use for the nodes.
  --default-route-network DEFAULT_ROUTE_NETWORK
                        Default route network to use for the nodes.
  --network NETWORK     Default networks to use for the nodes.

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
role_name	Да	Имя роли
image	Нет	Путь до образа для узлов роли
network-plan	Нет	Сетевой план для узлов роли
default-route-network	Нет	Сеть шлюза для узлов роли
network	Нет	Добавить сеть для сетевого плана.

Результат

Пустая строка, если команда выполнена успешно.

instance role unset

Описание

Удалить настройки по умолчанию для узлов роли

Использование

$ dctl instance role unset --help
usage: dctl instance role unset [-h] [--image] [--network-plan] [--default-route-network]
                                [--network NETWORK]
                                name role_name

positional arguments:
  name                  Instance name
  role_name             Role name assigned to the nodes of the instance

options:
  -h, --help            show this help message and exit
  --image               Remove default image's path to use for the nodes.
  --network-plan        Remove default network plan to use for the nodes.
  --default-route-network
                        Remove default route network to use for the nodes.
  --network NETWORK     Remove network from default networks.

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
role_name	Да	Имя роли
image	Нет	Удалить назначенный образ для узлов роли
network-plan	Нет	Удалить сетевой план назначенный для узлов роли
default-route-network	Нет	Удалить сеть шлюза назначенную для узлов роли
network	Нет	Удалить сеть для сетевого плана.

Результат

Пустая строка, если команда выполнена успешно.

instance backend list

Описание

Посмотреть список бэкендов для развёртывания

Использование

$ dctl instance backend list --help
usage: dctl instance backend list [-h] [-f {json,yaml,table}] name

positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания

instance backend add

Описание

Добавить бэкенд для развёртывания

Использование

$ dctl instance backend add --help
usage: dctl instance backend add [-h] --service {cinder,glance,nova} name storage/backend_type

positional arguments:
  name                  Instance name
  storage/backend_type  Name of storage or backend type

options:
  -h, --help            show this help message and exit
  --service {cinder,glance,nova}
                        Name of the service to which the backend will be added

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
storage/backend_type	Да	Тип бэкенда или имя хранилища
service	Да	Сервис для которого добавляется бэкенд Один из: cinder, glance, nova

Результат

Пустая строка, если команда выполнена успешно.

instance backend remove

Описание

Удалить бэкенд из развёртывания

Использование

$ dctl instance backend remove --help
usage: dctl instance backend remove [-h] --service {cinder,glance,nova} name storage/backend_type

positional arguments:
  name                  Instance name
  storage/backend_type  Name of storage or backend type

options:
  -h, --help            show this help message and exit
  --service {cinder,glance,nova}
                        Name of the service to which the backend will be added

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
storage/backend_type	Да	Тип бэкенда или имя хранилища
service	Да	Сервис для которого удаляется бэкенд Один из: cinder, glance, nova

Результат

Пустая строка, если команда выполнена успешно.

instance backend support

Описание

Показать список доступных бэкендов для облака

Использование

$ dctl instance backend support --help
usage: dctl instance backend support [-h] [-f {json,yaml,table}] [--service {cinder,glance,nova}] name

positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format
  --service {cinder,glance,nova}
                        Name of the service to query supported backends

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
service	Нет	Уточнить имя сервиса Один из: cinder, glance, nova

instance vip list

Описание

Посмотреть список виртуальных IP адресов для развёртывания

Использование

$ dctl instance vip list --help
usage: dctl instance vip list [-h] [-f {json,yaml,table}] name

positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания

instance vip add

Описание

Добавить виртуальный IP адрес

Использование

$ dctl instance vip add --help
usage: dctl instance vip add [-h] [--ip-address IP_ADDRESS] name network_name

positional arguments:
  name                  Instance name
  network_name          Name of the network

options:
  -h, --help            show this help message and exit
  --ip-address IP_ADDRESS
                        Fixed IP address for the virtual IP

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
network_name	Да	Имя сети
ip-address	Нет	Желаемый IP адрес

Результат

Пустая строка, если команда выполнена успешно.

instance vip delete

Описание

Удалить виртуальный IP адрес

Использование

$ dctl instance vip delete --help
usage: dctl instance vip delete [-h] name network_name

positional arguments:
  name          Instance name
  network_name  Name of the network

options:
  -h, --help    show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
network_name	Да	Имя сети

Результат

Пустая строка, если команда выполнена успешно.

instance password list

Описание

Посмотреть список паролей для развёртывания

Использование

$ dctl instance password list --help
usage: dctl instance password list [-h] [-f {json,yaml,table}] name

positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания

instance password generate

Описание

Сгенерировать пароли для развёртывания

Использование

$ dctl instance password generate --help
usage: dctl instance password generate [-h] name

positional arguments:
  name        Instance name

options:
  -h, --help  show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания

Результат

Пустая строка, если команда выполнена успешно.

instance password show

Описание

Посмотреть пароль для развёртывания

Использование

$ dctl instance password show --help
usage: dctl instance password show [-h] [-f {json,yaml,table}] name password_name

positional arguments:
  name                  Instance name
  password_name         Name of the password parameter

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
password_name	Да	Имя параметра

instance password set

Описание

Установить пароль для развёртывания

Использование

$ dctl instance password set --help
usage: dctl instance password set [-h] name password_name password_value

positional arguments:
  name            Instance name
  password_name   Name of the password parameter
  password_value  Password to set

options:
  -h, --help      show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
password_name	Да	Имя параметра
password_value	Да	Значение для параметра

Результат

Пустая строка, если команда выполнена успешно.

instance feature list

Описание

Посмотреть доступные функции для развёртывания

Использование

$ dctl instance feature list --help
usage: dctl instance feature list [-h] [-f {json,yaml,table}] [--enabled] name

positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format
  --enabled             Show only enabled features

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
enabled	Нет	Show only enabled features for the instance. Default: false

instance feature add

Описание

Добавить функцию для развёртывания

Использование

$ dctl instance feature add --help
usage: dctl instance feature add [-h] name feature_name

positional arguments:
  name          Instance name
  feature_name  Feature name

options:
  -h, --help    show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
feature_name	Да	Имя функции

Результат

Пустая строка, если команда выполнена успешно.

instance feature remove

Описание

Удалить функцию из развёртывания

Использование

$ dctl instance feature remove --help
usage: dctl instance feature remove [-h] name feature_name

positional arguments:
  name          Instance name
  feature_name  Feature name

options:
  -h, --help    show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
feature_name	Да	Имя функции

Результат

Пустая строка, если команда выполнена успешно.

instance feature set

Описание

Установить параметры функции для развёртывания

Использование

$ dctl instance feature set --help
usage: dctl instance feature set [-h] name feature_name parameter

positional arguments:
  name          Instance name
  feature_name  Feature name
  parameter     Parameter to set in key=value format

options:
  -h, --help    show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
feature_name	Да	Имя функции
parameter	Да	Имя и значение параметра. Формат: key=value

Результат

Пустая строка, если команда выполнена успешно.

instance feature show

Описание

Посмотреть параметры функции для развёртывания

Использование

$ dctl instance feature show --help
usage: dctl instance feature show [-h] [-f {json,yaml,table}] name feature_name

positional arguments:
  name                  Instance name
  feature_name          Feature name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
feature_name	Да	Имя функции

instance advanced show

Описание

Посмотреть расширенные настройки для развёртывания (только для экспертов)

Использование

$ dctl instance advanced show --help
usage: dctl instance advanced show [-h] [-f {json,yaml,table}] name

positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  -f {json,yaml,table}, --format {json,yaml,table}
                        Output format

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания

instance advanced set

Описание

Установить расширенные настройки для развёртывания (только для экспертов)

Использование

$ dctl instance advanced set --help
usage: dctl instance advanced set [-h] name option

positional arguments:
  name        Instance name
  option      Parameter name and value in key=value format

options:
  -h, --help  show this help message and exit

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
option	Да	Имя и значение параметра. Формат: key=value

Результат

Пустая строка, если команда выполнена успешно.

instance backup

Описание

Создать резервную копию данных на узлах развёртывания

Использование

$ dctl instance backup --help
usage: dctl instance backup [-h] [--host HOST | --role ROLE] [--all] [--config] [--mysql] [--logs]
                            [--data]
                            name

positional arguments:
  name         Instance name

options:
  -h, --help   show this help message and exit
  --host HOST  Node name to operate on.
  --role ROLE  Role for nodes to operate on.
  --all        Backup all targets
  --config     Backup target: config
  --mysql      Backup target: mysql
  --logs       Backup target: logs
  --data       Backup target: data

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
host	Нет	Имя узла
role	Нет	Имя роли
all	Нет	Создать резервную копию всех данных
config	Нет	Создать резервную копию конфигурационных файлов
mysql	Нет	Создать резервную копию базы данных MySQL
logs	Нет	Создать резервную копию логов
data	Нет	Создать резервную копию данных сервисов

Результат

Пустая строка, если команда выполнена успешно.

Инициализация OpenStack

См. также

1. Сопровождение облака и управление ресурсами

cloud prepare

Описание

Создать минимальные ресурсы для OpenStack: типы инстансов, образы, сети, роутер, ключ SSH.

Использование

$ dctl cloud prepare --help
usage: dctl cloud prepare [-h] [--flavors JSON or 'k1=v1,k2=v2...'] [--images path [path ...]]
                          [--public-network JSON or 'k1=v1,k2=v2...']
                          name

positional arguments:
  name                  Openstack name

options:
  -h, --help            show this help message and exit
  --flavors JSON or 'k1=v1,k2=v2...'
                        Flavors parameters: max_multiplier, disk_sfx, extra_specs.
                        Defaults: max_multiplier=8,disk_sfx=disk,extra_specs=None.
                        Replace disk_sfx with an actual disk type.
  --images path [path ...]
                        List of image paths to files and directories, whitespace-separated
  --public-network JSON or 'k1=v1,k2=v2...'
                        Create external network, geneve network and router.
                        Public network parameters:
                        vlan_id, cidr (required), gateway, pool_start, pool_end, no_dhcp, no_external, mtu.
                        If vlan_id is not provided, flat network will be created.
                        If gateway is not provided, no gateway will be set.
                        If pool_start/end not provided, defaults will be derived from CIDR.
                        If no_dhcp is set to true, DHCP will be disabled.
                        If no_external is set to true, router will not be created.
                        MTU applies only to public network. If private network is used, it will be set to Neutron default.

Пример

$ dctl cloud prepare --flavors max_multiplier=8,disk_sfx=ssd,extra_specs=None \
      --images /home/stack/images/ \
      --public-network vlan_id=100,cidr=10.10.10.0/24

Параметры

Имя	Обязательный	Описание
name	Да	Имя развёртывания
flavors	Нет	Параметры типов инстансов: max_multiplier, disk_sfx, extra_specs. По умолчанию: max_multiplier=8, disk_sfx=disk, extra_specs=None. Используйте hdd или ssd в зависимости от типа дисков на узлах
images	Нет	Список файлов и директорий с образами
public-network	Нет	Параметры публичной сети: vlan_id, cidr, gateway, pool_start, pool_end, no_dhcp, no_external, mtu. Cidr обязателен. Если нет vlan_id то будет использован тип сети flat. Если нет gateway, то параметр не будет использован. Если нет pool_start и pool_end, то pool_start/end будет установлен как 10-й IP адрес сначала/концы указанного CIDR. Если указан no_dhcp, то DHCP не будет настроен для сети. Если указан no_external, то не будет создан виртуальный маршрутизатор.

Результат

Пустая строка, если команда выполнена успешно.

Обновления

См. также

1. Ручное обновление

update packages

Описание

Обновить минимальный набор пакетов на узле undercloud

Использование

$ dctl update packages --help
usage: dctl update packages [-h] [--repo REPO]

options:
  -h, --help   show this help message and exit
  --repo REPO  Exiting DNF repository name to use for updates. Default: moncloud_updates

Параметры

Имя	Обязательный	Описание
repo	Нет	Репозиторий для обновления пакетов

Результат

Логи выполнения операции

update undercloud

Описание

Обновить все пакеты на узле и систему undercloud

Использование

$ dctl update undercloud --help
usage: dctl update undercloud [-h] [--repo REPO] [--use-deploy-image]

options:
  -h, --help          show this help message and exit
  --repo REPO         Exiting DNF repository name to use for updates. Default: moncloud_updates
  --use-deploy-image  Use deploy image for update process

Параметры

Имя	Обязательный	Описание
repo	Нет	Репозиторий для обновления пакетов
use-deploy-image	Нет	Использовать образ для развёртывания при поиске пакетов

Результат

Логи выполнения операции

update instances

Описание

Обновить развёртывания: минимально необходимые пакеты на узле развёртывания, шаблоны развёртываний, пакеты на узлах, сервисы развёртываний

Использование

$ dctl update instances --help
usage: dctl update instances [-h] [--repo REPO] [--use-deploy-image] [name ...]

positional arguments:
  name                Limit update to specific instance(s) by name

options:
  -h, --help          show this help message and exit
  --repo REPO         Exiting DNF repository name to use for updates. Default: moncloud_updates
  --use-deploy-image  Use deploy image for update process

Параметры

Имя	Обязательный	Описание
name	Нет	Имена развёртываний. Если не указаны, будут обновлены все развёртывания
repo	Нет	Репозиторий для обновления пакетов
use-deploy-image	Нет	Использовать образ для развёртывания при поиске пакетов

Результат

Логи выполнения операции