Spec-Zone.ru › Ansible 2.5

aws_ssm - Получение значения параметра SSM или всех параметров в заданном пути.

Новое в версии 2.5.

  • Обзор
    • Требования
  • Параметры
  • Примеры
  • Статус
    • Автор

Обзор

  • Получение значения параметра Amazon Simple Systems Manager или иерархии параметров. Первый аргумент, который вы передаёте в lookup, может быть именем параметра или иерархией параметров. Иерархии начинаются с обратного слэша и заканчиваются именем параметра. Может быть указано до 5 уровней.
  • При явном поиске параметра по имени отсутствие параметра будет ошибкой.
  • При поиске пути параметров под ним будет возвращён словарь для каждого пути. Если параметр под этим путём отсутствует, то возвращение будет успешным, но словарь будет пустым.

Требования

Ниже перечислены требования к локальному узлу-мастеру, на котором выполняется этот поиск.

  • boto3
  • botocore

Параметры

Параметр Варианты/Значения по умолчанию Настройка Комментарии
bypath Значение по умолчанию:
нет
Логическое значение, указывающее, предоставляется ли параметр в виде иерархии.
decrypt Значение по умолчанию:
да
Логическое значение, указывающее, нужно ли дешифровать параметр.
recursive Значение по умолчанию:
нет
Логическое значение, указывающее, нужно ли извлечь все параметры внутри иерархии.
shortnames Значение по умолчанию:
нет
Указывает, нужно ли вернуть только имя без пути при использовании иерархии параметра.

Примеры

# lookup sample:
- name: lookup ssm parameter store in the current region
  debug: msg="{{ lookup('aws_ssm', 'Hello' ) }}"

- name: lookup a key which doesn't exist, returns ""
  debug: msg="{{ lookup('aws_ssm', 'NoKey') }}"

- name: lookup ssm parameter store in nominated region
  debug: msg="{{ lookup('aws_ssm', 'Hello', region=us-east-2 ) }}"

- name: lookup ssm parameter store without decrypted
  debug: msg="{{ lookup('aws_ssm', 'Hello', decrypt=False ) }}"

- name: lookup ssm parameter store in nominated aws profile
  debug: msg="{{ lookup('aws_ssm', 'Hello', aws_profile=myprofile ) }}"

- name: lookup ssm parameter store with all options.
  debug: msg="{{ lookup('aws_ssm', 'Hello', decrypt=false, region=us-east-2, aws_profile=myprofile') }}"

- name: return a dictionary of ssm parameters from a hierarchy path
  debug: msg="{{ lookup('aws_ssm', '/PATH/to/params', region=ap-southeast-2, bypath=true, recursive=true' ) }}"

- name: return a dictionary of ssm parameters from a hierarchy path with shortened names (param instead of /PATH/to/param)
  debug: msg="{{ lookup('aws_ssm', '/PATH/to/params', region=ap-southeast-2, shortnames=true, bypath=true, recursive=true ) }}"

- name: Iterate over a parameter hierarchy
  debug: msg='key contains {{item.Name}} with value {{item.Value}} '
  loop: '{{ query("aws_ssm", "/TEST/test-list", region="ap-southeast-2", bypath=true) }}'

Статус

Автор

  • Bill Wang <ozbillwang(at)gmail.com>
  • Marat Bakeev <hawara(at)gmail.com>
  • Michael De La Rue <siblemitcom.mddlr@spamgourmet.com>

Подсказка

Если вы заметите какие-либо проблемы в этом руководстве, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/plugins/lookup/aws_ssm.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API