Модуль community.general.imc_rest — Управление оборудованием Cisco IMC через REST API
Примечание
Этот модуль входит в коллекцию community.general (версия 9.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в плейбуке укажите: community.general.imc_rest.
Обзор
- Обеспечивает прямой доступ к REST API Cisco IMC.
- Выполняет любые изменения конфигурации и действия, поддерживаемые Cisco IMC.
- Дополнительная информация о REST API IMC доступна по адресу http://www.cisco.com/c/en/us/td/docs/unified_computing/ucs/c/sw/api/3_0/b_Cisco_IMC_api_301.html.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- lxml
- xmljson >= 0.1.8
Параметры
Параметр | Комментарии |
|---|---|
content строка | При использовании вместо Это может быть удобно для шаблонизации простых запросов, для сложных используйте модуль ansible.builtin.template. Вы можете объединить несколько фрагментов XML IMC, и они будут обработаны последовательно в одном потоке, выходные данные Cisco IMC впоследствии объединяются. |
hostname алиасы: host, ip строка / обязательно | IP-адрес или имя хоста Cisco IMC, разрешимые управляющим хостом Ansible. |
password строка | Пароль для аутентификации. По умолчанию: |
path алиасы: src, config_file путь | |
protocol строка | Протокол подключения. Варианты:
|
timeout целое число | Таймаут соединения на уровне сокета в секундах. Это время, которое может потратить каждое отдельное соединение (каждый фрагмент). Если этот По умолчанию: |
username алиасы: user строка | Имя пользователя для входа на коммутатор. По умолчанию: |
validate_certs булево | Если Это следует устанавливать только в Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Может работать в |
diff_mode | Поддержка: нет | Вернёт детали того, что изменилось (или, возможно, нуждается в изменении в |
Примечания
Примечание
- Фрагменты XML не требуют куки аутентификации, это автоматически вводится модулем.
- Выходные данные Cisco IMC в формате XML преобразуются в JSON с использованием соглашений Cobra.
- Любое изменение, запрошенное для configConfMo, имеет статус «изменено», даже если не было фактических изменений по сравнению с предыдущей конфигурацией. В результате, этот модуль всегда будет сообщать об изменении при последующих запусках. В случае, если это поведение будет исправлено в будущих обновлениях Cisco IMC, этот модуль автоматически адаптируется.
- Если вы получаете ошибку
Connection failure, связанную сThe read operation timed out, увеличьте параметрtimeout. Некоторые фрагменты XML могут занимать больше времени, чем стандартный таймаут. - Дополнительная информация о REST API IMC доступна по адресу http://www.cisco.com/c/en/us/td/docs/unified_computing/ucs/c/sw/api/3_0/b_Cisco_IMC_api_301.html
Примеры
- name: Power down server
community.general.imc_rest:
hostname: '{{ imc_hostname }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
content: |
<configConfMo><inConfig>
<computeRackUnit dn="sys/rack-unit-1" adminPower="down"/>
</inConfig></configConfMo>
delegate_to: localhost
- name: Configure IMC using multiple XML fragments
community.general.imc_rest:
hostname: '{{ imc_hostname }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
timeout: 120
content: |
<!-- Configure Serial-on-LAN -->
<configConfMo><inConfig>
<solIf dn="sys/rack-unit-1/sol-if" adminState="enable" speed=="115200" comport="com0"/>
</inConfig></configConfMo>
<!-- Configure Console Redirection -->
<configConfMo><inConfig>
<biosVfConsoleRedirection dn="sys/rack-unit-1/bios/bios-settings/Console-redirection"
vpBaudRate="115200"
vpConsoleRedirection="com-0"
vpFlowControl="none"
vpTerminalType="vt100"
vpPuttyKeyPad="LINUX"
vpRedirectionAfterPOST="Always Enable"/>
</inConfig></configConfMo>
delegate_to: localhost
- name: Enable PXE boot and power-cycle server
community.general.imc_rest:
hostname: '{{ imc_hostname }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
content: |
<!-- Configure PXE boot -->
<configConfMo><inConfig>
<lsbootLan dn="sys/rack-unit-1/boot-policy/lan-read-only" access="read-only" order="1" prot="pxe" type="lan"/>
</inConfig></configConfMo>
<!-- Power cycle server -->
<configConfMo><inConfig>
<computeRackUnit dn="sys/rack-unit-1" adminPower="cycle-immediate"/>
</inConfig></configConfMo>
delegate_to: localhost
- name: Reconfigure IMC to boot from storage
community.general.imc_rest:
hostname: '{{ imc_host }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
content: |
<configConfMo><inConfig>
<lsbootStorage dn="sys/rack-unit-1/boot-policy/storage-read-write" access="read-write" order="1" type="storage"/>
</inConfig></configConfMo>
delegate_to: localhost
- name: Add customer description to server
community.general.imc_rest:
hostname: '{{ imc_host }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
content: |
<configConfMo><inConfig>
<computeRackUnit dn="sys/rack-unit-1" usrLbl="Customer Lab - POD{{ pod_id }} - {{ inventory_hostname_short }}"/>
</inConfig></configConfMo>
delegate_to: localhost
- name: Disable HTTP and increase session timeout to max value 10800 secs
community.general.imc_rest:
hostname: '{{ imc_host }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
timeout: 120
content: |
<configConfMo><inConfig>
<commHttp dn="sys/svc-ext/http-svc" adminState="disabled"/>
</inConfig></configConfMo>
<configConfMo><inConfig>
<commHttps dn="sys/svc-ext/https-svc" adminState="enabled" sessionTimeout="10800"/>
</inConfig></configConfMo>
delegate_to: localhost
Значения возврата
Общие значения возврата документированы здесь, ниже приведены поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
aaLogin словарь | Выход Cisco IMC в формате XML для входа, преобразованный в JSON с использованием соглашений Cobra Возвращается: успешно Пример: |
configConfMo словарь | Выход Cisco IMC в формате XML для фрагментов configConfMo, преобразованный в JSON с использованием соглашений Cobra Возвращается: успешно Пример: |
elapsed целое число | Время выполнения в секундах Возвращается: всегда Пример: |
error словарь | Ошибка Cisco IMC в формате XML для последнего запроса, преобразованная в JSON с использованием соглашений Cobra Возвращается: неудачно Пример: |
error_code строка | Код ошибки Cisco IMC Возвращается: неудачно Пример: |
error_text строка | Сообщение об ошибке Cisco IMC Возвращается: неудачно Пример: |
input строка | Необработанный XML-вход, отправленный в Cisco IMC, вызвавший ошибку Возвращается: неудачно Пример: |
output строка | Необработанный XML-выход, полученный от Cisco IMC, со сведениями об ошибке Возвращается: неудачно Пример: |
response строка | Сообщение HTTP-ответа, включая длину содержимого Возвращается: всегда Пример: |
status словарь | Код состояния HTTP-ответа Возвращается: всегда Пример: |
Ссылки на сборку
© 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/community/general/imc_rest_module.html