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

Примечание

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

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

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

Для использования в playbook, укажите: theforeman.foreman.location.

Новое в theforeman.foreman 1.0.0

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

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

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

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

Требования

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

requests

Параметры

Параметр	Комментарии
description string добавлено в theforeman.foreman 4.2.0	Описание местоположения
ignore_types псевдонимы: select_all_types list / элементы=string добавлено в theforeman.foreman 3.8.0	Список типов ресурсов, которые будут автоматически связаны
name string / обязательно	Имя местоположения
organizations list / элементы=string	Список организаций, которым должно быть назначено местоположение
parameters list / элементы=dictionary	Специфичные для домена сущности параметры хоста
name string / обязательно	Имя параметра
parameter_type string	Тип параметра Варианты: `"string"` ← (по умолчанию) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
value any / обязательно	Значение параметра
parent string	Заголовок родительского местоположения для вложенности
password string / обязательно	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
server_url string / обязательно	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
state string	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
username string / обязательно	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме check_mode и возвращать прогноз измененного статуса без изменения сущности
diff_mode	Поддержка: полная	В дифференциальном режиме вернет подробности о том, что изменилось (или что может потребовать изменения в режиме 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 словарь	Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращено: success
locations список / элементы=словарь	Список местоположений. Возвращено: success

Авторы

Matthias M 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/location_module.html