Spec-Zone.ru › Ansible 2.6

cs_host - Управляет хостами на облаках Apache CloudStack.

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

  • Описание
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус
  • Техническое обслуживание
    • Автор

Описание

  • Создание, обновление и удаление хостов.

Требования

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

  • python >= 2.6
  • cs >= 0.6.10

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
allocation_state
    Варианты:
  • enabled
  • disabled
Состояние выделения хоста.
api_http_method
    Варианты:
  • get
  • post
HTTP-метод, используемый для запроса к API-точке.
Если не задано, используется переменная окружения CLOUDSTACK_METHOD.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
Значение по умолчанию: get, если не указано.
api_key
API-ключ CloudStack API.
Если не задано, используется переменная окружения CLOUDSTACK_KEY.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_region Значение по умолчанию:
"cloudstack"
Имя раздела ini в файле cloustack.ini.
Если не задано, используется переменная окружения CLOUDSTACK_REGION.
api_secret
Секретный ключ CloudStack API.
Если не задано, используется переменная окружения CLOUDSTACK_SECRET.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_timeout
Таймаут HTTP в секундах.
Если не задано, используется переменная окружения CLOUDSTACK_TIMEOUT.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
Значение по умолчанию 10 секунд, если не указано.
api_url
URL CloudStack API, например, https://cloud.example.com/client/api.
Если не задано, используется переменная окружения CLOUDSTACK_ENDPOINT.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
cluster
Имя кластера.
host_tags
Теги хоста.

Псевдонимы: host_tag
hypervisor
    Варианты:
  • KVM
  • VMware
  • BareMetal
  • XenServer
  • LXC
  • HyperV
  • UCS
  • OVM
  • Simulator
Имя кластера.
Требуется, если state=present и хост еще не существует.
name
обязательно
Имя хоста.

Псевдонимы: ip_address
password
Пароль для хоста.
Требуется, если state=present и хост еще не существует.
pod
Имя подсети.
Требуется, если state=present и хост еще не существует.
state
    Варианты:
  • present ←
  • absent
Состояние хоста.
url
URL хоста, используемого для создания хоста.
Если не предоставлено, http:// и параметр name используются как URL.
Учитывается только если state=present и хост еще не существует.
username
Имя пользователя для хоста.
Требуется, если state=present и хост еще не существует.
zone
Имя зоны, в которой должен быть развернут хост.
Если не задано, используется зона по умолчанию.

Примечания

Примечание

  • Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены параметрами api_url, api_key, api_secret. Конфигурация считывается из нескольких источников в указанном порядке. Переменные окружения CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменная окружения CLOUDSTACK_TIMEOUT указывающая на файл CLOUDSTACK_CONFIG. Файл cloudstack.ini в текущем рабочем каталоге. Файл .cloudstack.ini в домашнем каталоге пользователя. Допустимо указывать несколько учетных данных и точек доступа с использованием разделов ini в cloudstack.ini. Используйте параметр api_region для выбора имени раздела, раздел по умолчанию cloudstack. Более подробная информация на https://github.com/exoscale/cs.
  • Подробное руководство по модулям cloudstack можно найти в Руководстве по облаку CloudStack.
  • Этот модуль поддерживает режим проверки.

Примеры

- name: Ensure a host is present but disabled
  local_action:
    module: cs_host
    name: ix-pod01-esx01.example.com
    cluster: vcenter.example.com/ch-zrh-ix/pod01-cluster01
    pod: pod01
    zone: ch-zrh-ix-01
    hypervisor: VMware
    allocation_state: disabled
    host_tags:
    - perf
    - gpu

- name: Ensure an existing host is disabled
  local_action:
    module: cs_host
    name: ix-pod01-esx01.example.com
    zone: ch-zrh-ix-01
    allocation_state: disabled

- name: Ensure an existing host is disabled
  local_action:
    module: cs_host
    name: ix-pod01-esx01.example.com
    zone: ch-zrh-ix-01
    allocation_state: enabled

- name: Ensure a host is absent
  local_action:
    module: cs_host
    name: ix-pod01-esx01.example.com
    zone: ch-zrh-ix-01
    state: absent

Значения возврата

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

Ключ Возвращаемое значение Описание
allocation_state:
строка
 success
Состояние распределения ресурсов хоста.

Пример:
enabled
capabilities
строка
 success
Возможности хоста.

Пример:
hvm
cluster
строка
 success
Кластер хоста.

Пример:
vcenter.example.com/zone/cluster01
cluster_type
строка
 success
Тип кластера хоста.

Пример:
ExternalManaged
cpu_allocated
строка
 success
Процент процессорного времени хоста, в настоящее время выделенный.

Пример:
166.25%
cpu_number
строка
 success
Количество процессоров хоста.

Пример:
24
cpu_sockets
целое число
 success
Количество сокетов процессора хоста.

Пример:
2
cpu_speed
целое число
 success
Частота процессора в МГц

Пример:
1999
cpu_used
строка
 success
Процент процессорного времени хоста, в настоящее время используемый.

Пример:
33.6%
cpu_with_overprovisioning
строка
 success
Количество процессорного времени хоста после применения фактора cpu.overprovisioning.factor.

Пример:
959520.0
created
строка
 success
Дата создания хоста.

Пример:
2015-05-03T15:05:51+0200
disconnected
строка
 success
Дата отключения хоста.

Пример:
2015-05-03T15:05:51+0200
disk_size_allocated
целое число
 success
Текущий размер выделенного дискового пространства хоста.

Пример:
2593
disk_size_total
целое число
 success
Общий размер дискового пространства хоста

Пример:
259300
events
строка
 success
Доступные события для хоста

Пример:
Ping; HostDown; AgentConnected; AgentDisconnected; PingTimeout; ShutdownRequested; Remove; StartAgentRebalance; ManagementServerDown
gpu_group
список
 success
Наличие графических процессоров в хосте.
ha_host
логическое
 success
Является ли хост хостом HA.
has_enough_capacity
логическое
 success
Достаточно ли у хоста ресурсов процессора и оперативной памяти для миграции виртуальной машины на него.

Пример:
True
host_tags
строка
 success
Список тегов хоста, разделенных запятыми.

Пример:
perf
host_type
строка
 success
Тип хоста.

Пример:
Routing
host_version
строка
 success
Версия хоста.

Пример:
4.5.2
hypervisor
строка
 success
Гипервизор хоста.

Пример:
VMware
hypervisor_version
строка
 success
Версия гипервизора.

Пример:
5.1
ip_address
строка
 success
IP-адрес хоста

Пример:
10.10.10.1
is_local_storage_active
логическое
 success
Доступно ли локальное хранилище.
last_pinged
строка
 success
Дата и время последнего пинга хоста.

Пример:
1970-01-17T17:27:32+0100
management_server_id
целое число
 success
Идентификатор сервера управления хоста.

Пример:
345050593418
memory_allocated
целое число
 success
Объем оперативной памяти хоста, в настоящее время выделенной.

Пример:
69793218560
memory_total
целое число
 success
Общий объем оперативной памяти хоста.

Пример:
206085263360
memory_used
целое число
 success
Объем оперативной памяти хоста, в настоящее время используемый.

Пример:
65504776192
name
строка
 success
Имя хоста.

Пример:
esx32.example.com
network_kbs_read
целое число
 success
Входящий сетевой трафик на хост.
network_kbs_write
целое число
 success
Исходящий сетевой трафик с хоста.
os_category
строка
 success
Имя категории операционной системы хоста.

Пример:
...
out_of_band_management
строка
 success
Информация об управлении хостом вне полосы пропускания.

Пример:
...
pod
string
 success
Имя подсети узла.

Пример:
Pod01
removed
string
 success
Дата и время удаления узла.

Пример:
1970-01-17T17:27:32+0100
resource_state
string
 success
Состояние ресурса узла.

Пример:
Enabled
state
string
 success
Состояние узла.

Пример:
Up
suitable_for_migration
string
 success
Подходит ли этот узел для миграции виртуальной машины (имеет достаточную емкость и удовлетворяет всем условиям, таким как теги узла, максимальное ограничение виртуальных машин и т.д.) или нет.

Пример:
True
zone
string
 success
Зона узла.

Пример:
zone01


Статус

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

Техническое обслуживание

Этот модуль помечен как общественный, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

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

Автор

  • René Moser (@resmo)

Подсказка

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

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

Spec-Zone.ru

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