Модуль theforeman.foreman.location — управление расположениями

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.location.

Добавлено в theforeman.foreman 1.0.0

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

Краткое описание

Управление расположениями

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

Требования

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

requests

Параметры

Параметр	Комментарии
ca_path путь	Файл в формате PEM, содержащий сертификат CA для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_CA_PATH`.
description строка добавлено в theforeman.foreman 4.2.0	Описание расположения
ignore_types псевдонимы: select_all_types список / элементы=строка добавлено в theforeman.foreman 3.8.0	Список типов ресурсов, которые будут автоматически связаны
name строка / обязательный	Имя расположения
oauth1_consumer_key строка	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret строка	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organizations список / элементы=строка	Список организаций, которым должно быть назначено расположение
parameters список / элементы=словарь	Параметры хоста, относящиеся к домену сущности
hidden_value логическое значение	Следует ли скрыть значение Варианты: `false` `true`
name строка / обязательный	Имя параметра
parameter_type строка	Тип параметра Варианты: `"string"` ← (по умолчанию) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
value любое значение / обязательный	Значение параметра
parent строка	Название родительского расположения для создания вложенности
password строка	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
server_url строка / обязательный	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
state строка	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
use_gssapi логическое значение	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos с аутентификацией через Negotiate. Требуется установленная библиотека Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username строка	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_USERNAME`.
validate_certs логическое значение	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Можно выполнять в режиме check_mode и возвращать прогноз изменения состояния, не изменяя сущность
diff_mode	Поддержка: полная	В режиме diff будут возвращены сведения об изменениях (или о возможных изменениях в режиме check_mode)

Примеры

# Create a simple location
- name: "Create CI Location"
  theforeman.foreman.location:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "My Cool New Location"
    organizations:
      - "Default Organization"
    state: present

# Create a nested location
- name: "Create Nested CI Location"
  theforeman.foreman.location:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "My Nested location"
    parent: "My Cool New Location"
    state: present

# Create a new nested location with parent included in name
- name: "Create New Nested Location"
  theforeman.foreman.location:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "My Cool New Location/New nested location"
    state: present

# Move a nested location to another parent
- name: "Create Nested CI Location"
  theforeman.foreman.location:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "My Cool New Location/New nested location"
    parent: "My Cool New Location/My Nested location"
    state: present

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

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

Ключ	Описание
entity словарь	Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: при успешном выполнении
locations список / элементы=словарь	Список расположений. Возвращается: при успешном выполнении

Авторы

Matthias M Dellweg (@mdellweg) ATIX AG

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

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