Spec-Zone.ru › Ansible

Модуль theforeman.foreman.job_template – Управление шаблонами заданий

Примечание

Этот модуль является частью коллекции theforeman.foreman (версия 4.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в книге задач укажите: theforeman.foreman.job_template.

Новая функция в theforeman.foreman 1.0.0

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

Описание

  • Управление шаблонами заданий удалённого выполнения

Псевдонимы: foreman_job_template

Требования

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

  • requests

Параметры

Параметр

Комментарии

audit_comment

строка

Содержимое поля комментария аудита

description_format

строка

Описание шаблона задания. Можно использовать шаблоны ввода.

file_name

путь

Путь к файлу шаблона, который должен быть импортирован.

Требуется либо этот параметр, либо параметр template в качестве источника содержимого шаблона задания.

job_category

строка

Категория, к которой должен быть назначен шаблон.

locations

список / элементы=строка

Список местоположений, которым должна быть назначена сущность.

locked

булево

Определяет, должен ли шаблон быть заблокированным

Варианты:

  • false ← (по умолчанию)
  • true

name

строка

Имя шаблона задания.

Если опущено, будет определено из заголовка шаблона name или имени файла (в этом порядке).

Специальное значение «*» может использоваться для выполнения массовых действий (изменение, удаление) со всеми существующими шаблонами.

organizations

список / элементы=строка

Список организаций, которым должна быть назначена сущность.

password

строка / обязательно

Пароль пользователя, имеющего доступ к серверу Foreman.

Если значение не указано в задании, используется значение переменной окружения FOREMAN_PASSWORD.

provider_type

строка

Определяет, посредством какого поставщика должен быть выполнен шаблон.

server_url

строка / обязательно

URL сервера Foreman.

Если значение не указано в задании, используется значение переменной окружения FOREMAN_SERVER_URL.

snippet

булево

Определяет, должен ли шаблон быть фрагментом

Варианты:

  • false
  • true

state

строка

Состояние сущности

present_with_defaults гарантирует существование сущности, но не будет обновлять существующие

Варианты:

  • "present" ← (по умолчанию)
  • "present_with_defaults"
  • "absent"

template

строка

Содержимое шаблона задания.

Требуется либо этот параметр, либо параметр file_name в качестве источника содержимого шаблона задания.

template_inputs

список / элементы=словарь

Вводные данные шаблона, используемые в шаблоне задания.

advanced

булево

Вводные данные шаблона являются расширенными

Варианты:

  • false
  • true

default

строка

добавлен в theforeman.foreman 3.8.0

Значение по умолчанию для пользовательского ввода

description

строка

Описание входных данных шаблона

fact_name

строка

Имя факта для использования.

Требуется, когда input_type=fact.

hidden_value

булево

Значение содержит конфиденциальную информацию и обычно не должно быть видимым, например, для паролей

Варианты:

  • false
  • true

input_type

строка / обязательно

Тип ввода

Варианты:

  • "user"
  • "fact"
  • "variable"
  • "puppet_parameter"

name

строка / обязательно

Имя входных данных шаблона

options

список / элементы=любой

Значения шаблона для пользовательских входных данных. Должен быть массивом любого типа.

puppet_class_name

строка

Имя класса Puppet.

Требуется при input_type=puppet_parameter.

puppet_parameter_name

строка

Имя параметра Puppet.

Требуется при input_type=puppet_parameter.

required

логическое

Требуется ли входной параметр

Варианты:

  • false
  • true

resource_type

строка

Тип ресурса

value_type

строка

Тип значения

Варианты:

  • "plain"
  • "search"
  • "date"
  • "resource"

variable_name

строка

Имя переменной для использования.

Требуется при input_type=variable.

username

строка / обязательно

Имя пользователя, получающего доступ к серверу Foreman.

Если значение не указано в задаче, используется значение переменной окружения FOREMAN_USERNAME.

validate_certs

логическое

Проверять ли сертификаты TLS сервера Foreman.

Если значение не указано в задаче, используется значение переменной окружения FOREMAN_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Может работать в режиме check_mode и возвращать прогноз изменённого статуса без изменения сущности

diff_mode

Поддержка: полная

Возвращает подробную информацию о том, что изменилось (или, возможно, требует изменения в режиме check_mode), когда включен режим diff

Примеры

- name: "Create a Job Template inline"
  theforeman.foreman.job_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: A New Job Template
    state: present
    template: |
      <%#
          name: A Job Template
      %>
      rm -rf <%= input("toDelete") %>
    template_inputs:
      - name: toDelete
        input_type: user
    locations:
      - Gallifrey
    organizations:
      - TARDIS INC

- name: "Create a Job Template from a file"
  theforeman.foreman.job_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: a new job template
    file_name: timeywimey_template.erb
    template_inputs:
      - name: a new template input
        input_type: user
    state: present
    locations:
      - Gallifrey
    organizations:
      - TARDIS INC

- name: "remove a job template's template inputs"
  theforeman.foreman.job_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: a new job template
    template_inputs: []
    state: present
    locations:
      - Gallifrey
    organizations:
      - TARDIS INC

- name: "Delete a Job Template"
  theforeman.foreman.job_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: timeywimey
    state: absent

- name: "Create a Job Template from a file and modify with parameter(s)"
  theforeman.foreman.job_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    file_name: timeywimey_template.erb
    name: Wibbly Wobbly Template
    state: present
    locations:
      - Gallifrey
    organizations:
      - TARDIS INC

# Providing a name in this case wouldn't be very sensible.
# Alternatively make use of with_filetree to parse recursively with filter.
- name: Parsing a directory of Job templates
  theforeman.foreman.job_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    file_name: "{{ item }}"
    state: present
    locations:
      - SKARO
    organizations:
      - DALEK INC
  with_fileglob:
    - "./arsenal_templates/*.erb"

# If the templates are stored locally and the ansible module is executed on a remote host
- name: Ensure latest version of all your Job Templates
  theforeman.foreman.job_template:
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present
    template: '{{ lookup("file", item.src) }}'
    name: '{{ item.path }}'
  with_filetree: '/path/to/job/templates'
  when: item.state == 'file'


# with name set to "*" bulk actions can be performed
- name: "Delete *ALL* Job Templates"
  theforeman.foreman.job_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "*"
    state: absent

- name: "Assign all Job Templates to the same organization(s)"
  theforeman.foreman.job_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "*"
    state: present
    organizations:
      - DALEK INC
      - sky.net
      - Doc Brown's garage

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:

Ключ

Описание

entity

словарь

Конечное состояние затронутых сущностей, сгруппированных по их типу.

Возвращается: успех

job_templates

список / элементы=словарь

Список шаблонов задач.

Возвращается: успех

template_inputs

список / элементы=словарь

Список входных данных шаблона, связанных с шаблоном задачи.

Возвращается: успех

Авторы

  • Manuel Bonk (@manuelbonk) ATIX AG
  • Matthias Dellweg (@mdellweg) ATIX AG

Ссылки на коллекции

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (Исходные файлы)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/job_template_module.html

Spec-Zone.ru

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