Spec-Zone.ru › Ansible 2.4

packet_device - Управление сервером в Packet Host.

Новая версия с 2.3.

  • Обзор
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Обзор

  • Управление сервером без операционной системы в Packet Host (в терминах API — «устройство»).
  • При создании машины можно необязательно дождаться публичного IP-адреса или активного состояния.
  • Этот модуль зависит от packet >= 1.0.
  • Документация API находится по адресу https://www.packet.net/developers/api/devices.

Требования (к хосту, на котором выполняется модуль)

  • packet-python >= 1.35

Параметры

параметр обязательно значение по умолчанию выбор комментарии
always_pxe
(добавлен в 2.4)
нет
Сохранить PXE в качестве первого варианта загрузки.
Обычно процесс PXE происходит только при первой загрузке. Установите этот аргумент, чтобы ваше устройство постоянно загружалось в iPXE.
auth_token
нет
Токен API Packet. Вы также можете передать его в переменной среды PACKET_API_TOKEN.
count
нет 1
Количество устройств для создания. Количество может быть включено в имя хоста с помощью форматировщика строк %d.
count_offset
нет 1
С какого номера начать подсчёт.
device_ids
нет
Список идентификаторов устройств, на которых нужно выполнить операцию.
facility
нет
Facility slug для создания устройства. См. Packet API для текущего списка - https://www.packet.net/developers/api/facilities/.
features
нет
Словарь с "функциями" для создания устройства. См. документацию Packet API для подробностей.
hostnames
нет
Имя хоста устройства или список имён хостов.
Если передана строка или список из одного элемента, вы можете использовать "%d" Python для форматирования строк, чтобы расширить числа из count.
Если имя хоста только одно, оно может быть расширено до списка, если count>1.
псевдонимы: name
ipxe_script_url
(добавлен в 2.4)
нет
URL пользовательского скрипта iPXE для настройки.
Подробнее о пользовательском iPXE для устройств Packet на https://help.packet.net/technical/infrastructure/custom-ipxe.
locked
(добавлен в 2.4)
нет
Блокировать ли созданное устройство.
псевдонимы: lock
operating_system
нет
OS slug для создания устройства. См. Packet API для текущего списка - https://www.packet.net/developers/api/operatingsystems/.
plan
нет
Plan slug для создания устройства. См. Packet API для текущего списка - https://www.packet.net/developers/api/plans/.
project_id
да
Идентификатор проекта устройства.
state
нет present
  • present
  • absent
  • active
  • inactive
  • rebooted
Желаемое состояние устройства.
Если установлено в present (значение по умолчанию), вызов модуля вернётся сразу после успешного возврата HTTP-запроса для создания устройства.
Если установлено в active, вызов модуля заблокируется, пока все указанные устройства не перейдут в состояние активного по API Packet или до wait_timeout.
user_data
нет
Данные пользователя, доступные для машины.
wait
нет
Дождаться ли назначения адреса IP экземпляру перед возвратом.
Этот параметр устарел в пользу wait_for_public_IPv.
wait_for_public_IPv
(добавлен в 2.4)
нет
  • 4
  • 6
Дождаться ли назначения публичного IPv4/IPv6-адреса экземпляру.
Если установлено в 4, будет дождаться назначения IPv4 экземпляру.
Если установлено в 6, будет дождаться назначения публичного IPv6 экземпляру.
wait_timeout
нет 900
Сколько времени (в секундах) ждать либо автоматического назначения IP-адреса, либо перехода устройства в состояние active state.
Если wait_for_public_IPv установлено и state установлено в active, модуль будет ждать обоих событий последовательно, применяя таймаут дважды.

Примеры

# All the examples assume that you have your Packet api token in env var PACKET_API_TOKEN.
# You can also pass it to the auth_token parameter of the module instead.

# Creating devices

- name: create 1 device
  hosts: localhost
  tasks:
  - packet_device:
      project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
      hostnames: myserver
      operating_system: ubuntu_16_04
      plan: baremetal_0
      facility: sjc1

# Create the same device and wait until it is in state "active", (when it's
# ready for other API operations). Fail if the devices in not "active" in
# 10 minutes.

- name: create device and wait up to 10 minutes for active state
  hosts: localhost
  tasks:
  - packet_device:
      project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
      hostnames: myserver
      operating_system: ubuntu_16_04
      plan: baremetal_0
      facility: sjc1
      state: active
      wait_timeout: 600

- name: create 3 ubuntu devices called server-01, server-02 and server-03
  hosts: localhost
  tasks:
  - packet_device:
      project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
      hostnames: server-%02d
      count: 3
      operating_system: ubuntu_16_04
      plan: baremetal_0
      facility: sjc1

- name: Create 3 coreos devices with userdata, wait until they get IPs and then wait for SSH
  hosts: localhost
  tasks:
  - name: create 3 devices and register their facts
    packet_device:
      hostnames: [coreos-one, coreos-two, coreos-three]
      operating_system: coreos_stable
      plan: baremetal_0
      facility: ewr1
      locked: true
      project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
      wait_for_public_IPv: 4
      user_data: |
        #cloud-config
        ssh_authorized_keys:
          - {{ lookup('file', 'my_packet_sshkey') }}
        coreos:
          etcd:
            discovery: https://discovery.etcd.io/6a28e078895c5ec737174db2419bb2f3
            addr: $private_ipv4:4001
            peer-addr: $private_ipv4:7001
          fleet:
            public-ip: $private_ipv4
          units:
            - name: etcd.service
              command: start
            - name: fleet.service
              command: start
    register: newhosts

  - name: wait for ssh
    wait_for:
      delay: 1
      host: "{{ item.public_ipv4 }}"
      port: 22
      state: started
      timeout: 500
    with_items: "{{ newhosts.devices }}"


# Other states of devices

- name: remove 3 devices by uuid
  hosts: localhost
  tasks:
  - packet_device:
      project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
      state: absent
      device_ids:
        - 1fb4faf8-a638-4ac7-8f47-86fe514c30d8
        - 2eb4faf8-a638-4ac7-8f47-86fe514c3043
        - 6bb4faf8-a638-4ac7-8f47-86fe514c301f

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

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

имя описание возвращается тип пример
changed
Истина, если устройство было изменено каким-либо образом (создано, изменено или удалено)
успех bool True
devices
Информация о каждом обработанном устройстве
успех список [{"hostname": "my-server.com", "id": "2a5122b9-c323-4d5c-b53c-9ad3f54273e7", "public_ipv4": "147.229.15.12", "private-ipv4": "10.0.15.12", "tags": [], "locked": false, "state": "provisioning", "public_ipv6": ""2604:1380:2:5200::3"}]

Примечания

Примечание

  • Не поддерживает режим проверки.

Статус

Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется как обратная совместимость.

Для помощи в разработке модулей, если вам это нужно, прочитайте Информацию о сообществе и вклад, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

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