configure

Создает или обновляет профиль конфигурации для подключения к экземпляру каталога.

Профиль — это набор пар ключ-значение, которые позволяет подключаться к конкретному экземпляру каталога без указания параметров подключения в явном виде. Вы можете иметь несколько профилей для подключения к разным экземплярам каталога.

После создания профиля вы можете запускать команды, указывая имя профиля вместо параметров подключения. Например, следующая команда будет использовать профиль qa:

catalog --profile qa principal list

Если опция --profile не указана, будет использован профиль по умолчанию default (при условии, что он был предварительно сконфигурирован):

catalog principal list

По умолчанию утилита хранит информацию о профилях в файле ~/.config/cedrusdata/catalog/profiles. Если задана переменная окружения XDG_CONFIG_HOME, то утилита будет использовать файл $XDG_CONFIG_HOME/cedrusdata/catalog/profiles. Вы также можете переопределить местонахождение файла с помощью опции --profile-file:

catalog --profile-file=/custom/profiles --profile qa principal list

Подключение к каталогу с помощью профиля происходит с использованием постоянного токена доступа. Вы можете передать существующий токен доступа при создании или обновления профиля. Если у вас нет токена доступа, вы можете передать имя пользователя и пароль, после чего команда configure запросит новый постоянный токен доступа и сохранит его в профиле.

Если вы запускаете команду без дополнительных опций, конфигурация профиля будет осуществлена в интерактивном режиме:

catalog configure

Синтаксис

catalog configure
  [--profile=<profile>]
  [--endpoint=<endpoint>]
  [--access-token-file=<accessTokenFile> | --access-token=<accessToken>]]
  [[--principal-name=<principalName>(--password-file=<passwordFile> | --password=<password>)] |
  [--keystore-path=<keystorePath>]
  [--keystore-password-file=<keystorePasswordFile> | --keystore-password=<keystorePassword>]
  [--truststore-path=<truststorePath>]
  [--truststore-password-file=<truststorePasswordFile> | --truststore-password=<truststorePassword>]
  [--ssl-verification=<sslVerification>]

Опции

--profile Имя профиля, который необходимо сконфигурировать. Значение по умолчанию: default.

--endpoint Адрес каталога в формате http[s]://host[:port]. Значение по умолчанию: http://127.0.0.1:9080.

--access-token-file Путь к файлу с постоянным токеном доступа. Используйте параметры --principal-name и --password-file | --password, если у вас нет токена.

--access-token Постоянный токен доступа в явном виде. Небезопасно, рекомендуем использовать --access-token-file. Используйте параметры --principal-name и --password-file | --password, если у вас нет токена.

--principal-name Имя пользователя. Используйте данный параметр, если у вас нет постоянного токена доступа.

--password-file Файл с паролем пользователя. Используйте данный параметр, если у вас нет постоянного токена доступа.

--password Пароль пользователя в явном виде. Небезопасно, рекомендуем использовать --password-file. Используйте данный параметр, если у вас нет постоянного токена доступа.

--keystore-path Путь к keystore в формате PEM или JKS (только для HTTPS).

--keystore-password-file Путь к файлу с паролем keystore (только для HTTPS).

--keystore-password Пароль keystore в явном виде (только для HTTPS). Небезопасно, рекомендуем использовать --keystore-password-file.

--truststore-path Путь к truststore в формате PEM или JKS (только для HTTPS).

--truststore-password-file Путь к файлу с паролем truststore (только для HTTPS).

--truststore-password Пароль truststore в явном виде (только для HTTPS). Небезопасно, рекомендуем использовать --truststore-password-file.

--ssl-verification Способ валидации сертификата сервера (только для HTTPS). Допустимые значения: full - проверять сертификат и hostname сервера, ca - проверять только сертификат сервера, none - не проверять сертификат сервера. Используйте режим none только для тестирования (например, с самоподписанными сертификатами). Значение по умолчанию: full.