Структура команды#
Основу CLI контроллера составляет утилита awx
, синтаксис вызова которой имеет следующий вид:
[<enviroments>] awx [<global-options>] <resource> <action> [<arguments>]
<enviroments> – переменные окружения:
CONTROLLER_HOST
– URL контроллера.CONTROLLER_VERIFY_SSL
– параметры проверки сертификата TLS. Возможные значения:true
– строгая проверка сертификата;false
– проверка сертификата не выполняется.
CONTROLLER_USERNAME
– название учетной записи пользователя контроллера.CONTROLLER_PASSWORD
– пароль пользователя контроллера.CONTROLLER_OAUTH_TOKEN
– токен пользователя контроллера.
Примечание
Переменные окружения и глобальные опции, указывающие одни и те же значения, не могут использоваться одновременно.
<global-options> – глобальные опции, которые могут применяться ко всем командам:
- -h, --help#
Информация о доступных опциях и командах.
- -v, --verbose#
Дополнительная информация о ходе выполнения команды.
- --conf.host#
URL контроллера.
- -k, --conf.insecure#
Разрешение небезопасного соединения с сервером при использовании сертификатов TLS.
- --conf.username#
Название учетной записи пользователя контроллера.
- --conf.password#
Пароль пользователя контроллера.
- --conf.token#
Токен пользователя контроллера.
<resource> – тип объекта или ресурса. Для получения полного списка объектов и ресурсов выполните команду:
awx --help
<action> – действие, которое необходимо выполнить с объектом или ресурсом. Ресурсы и объекты, как правило, имеют базовый набор действий:
get
– получение сведений об отдельном экземпляре;list
– получение списка экземпляров;create
– создание экземпляра;modify
– изменение свойств существующего экземпляра;delete
– удаление экземпляра.
Чтобы узнать полный список доступных действий для конкретного объекта или ресурса, выполните команду:
awx <resource> --help
<arguments> – дополнительные параметры, которые можно передать вместе с командой. Например, идентификатор инвентаря или проекта, название задания и другие.
Примеры использования CLI#
Вывод списка организаций:
awx organizations list -f human
Пример вывода команды:
id name
== ======================
1 Default
Вывод информации о необходимой организации:
awx organizations get <organizations_id>
Здесь <organizations_id> – идентификатор организации, например, 1
.
Пример вывода команды:
Cоздание организации:
awx organizations create --name "<your_organization_name>"
Здесь <your_organization_name> – название организации, например, Saturn
.
Пример вывода команды:
Изменение названия организации:
awx organizations modify <organization_id> --name "<new_name_organization>"
Здесь <new_name_organization> – новое название организации, например, Neptune
.
Пример вывода команды:
Удаление организации:
awx organizations delete <organization_id>