Spec-Zone.ru › Ansible 2.4

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

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

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

Описание

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

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

  • python >= 2.6
  • cs >= 0.6.10

Параметры

параметр обязателен по умолчанию возможные значения комментарии
allocation_state
нет
  • enabled
  • disabled
Состояние выделения хоста.
api_http_method
нет get
  • get
  • post
Используемый HTTP-метод.
api_key
нет
Ключ API CloudStack API.
api_region
нет cloudstack
Имя раздела ini в файле cloustack.ini.
api_secret
нет
Секретный ключ CloudStack API.
api_timeout
нет 10
Таймаут HTTP.
api_url
нет
URL CloudStack API, например https://cloud.example.com/client/api.
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
  • present
  • absent
Состояние хоста.
url
нет
Url хоста, используемого для создания хоста.
Если не указано, http:// и параметр name используется как url.
Учитывается только если state=present и хост еще не существует.
username
нет
Имя пользователя для хоста.
Требуется, если state=present и хост еще не существует.
zone
нет
Имя зоны, в которой должен быть развернут хост.
Если не задано, используется зона по умолчанию.

Примеры

- 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

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

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

name description returned type sample
allocation_state:
Состояние распределения хоста.
success string enabled
capabilities
Возможности хоста.
success string hvm
cluster
Кластер хоста.
success string vcenter.example.com/zone/cluster01
cluster_type
Тип кластера хоста.
success string ExternalManaged
cpu_allocated
Процент ЦП хоста, который в настоящее время выделен.
success string 166.25%
cpu_number
Количество ЦП хоста.
success string 24
cpu_sockets
Количество сокетов ЦП хоста.
success int 2
cpu_speed
Частота ЦП в МГц.
success int 1999
cpu_used
Процент ЦП хоста, который в настоящее время используется.
success string 33.6%
cpu_with_overprovisioning
Количество ЦП хоста после применения cpu.overprovisioning.factor.
success string 959520.0
created
Дата создания хоста.
success string 2015-05-03T15:05:51+0200
disconnected
Дата отключения хоста.
success string 2015-05-03T15:05:51+0200
disk_size_allocated
Текущий размер выделенного диска хоста.
success int 2593
disk_size_total
Общий размер диска хоста
success int 259300
events
Доступные события для хоста
success string Ping; HostDown; AgentConnected; AgentDisconnected; PingTimeout; ShutdownRequested; Remove; StartAgentRebalance; ManagementServerDown
gpu_group
Наличие видеокарт на хосте.
success list []
ha_host
Является ли хост хостом HA.
success bool False
has_enough_capacity
Достаточно ли на хосте ресурсов ЦП и ОЗУ для миграции виртуальной машины на него.
success bool True
host_tags
Список тегов хоста, разделенных запятыми.
success string perf
host_type
Тип хоста.
success string Routing
host_version
Версия хоста.
success string 4.5.2
hypervisor
Гипервизор хоста.
success string VMware
hypervisor_version
Версия гипервизора.
success string 5.1
ip_address
IP-адрес хоста
success string 10.10.10.1
is_local_storage_active
Доступен ли локальный хранилище или нет.
success bool False
last_pinged
Дата и время последнего пинга хоста.
success string 1970-01-17T17:27:32+0100
management_server_id
ID сервера управления хоста.
success int 345050593418
memory_allocated
Выделенный объем памяти хоста.
success int 69793218560
memory_total
Общий объем памяти хоста.
success int 206085263360
memory_used
Используемый объем памяти хоста.
success int 65504776192
name
Имя хоста.
success string esx32.example.com
network_kbs_read
Входящий сетевой трафик на хосте.
success int 0
network_kbs_write
Исходящий сетевой трафик на хосте.
success int 0
os_category
Имя категории ОС хоста.
success string ...
out_of_band_management
Информация о внеполосном управлении хостом.
success string ...
pod
Имя подсети хоста.
success string Pod01
removed
Дата и время удаления хоста.
success string 1970-01-17T17:27:32+0100
resource_state
Состояние ресурса хоста.
success string Enabled
state
Состояние хоста.
success string Up
suitable_for_migration
Подходит ли этот хост для миграции виртуальной машины (имеет достаточные ресурсы и соответствует всем условиям, таким как hosttags, максимальное ограничение по виртуальным машинам и т. д.) или нет.
success string True
zone
Зона хоста.
success string zone01

Примечания

Примечание

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

Статус

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

Для получения помощи в разработке модулей обратитесь к Информация о сообществе и участие, Тестирование 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/cs_host_module.html

Spec-Zone.ru

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